Skip to content

Commit f5e76bf

Browse files
committed
update readme
1 parent 8757cdd commit f5e76bf

File tree

1 file changed

+24
-45
lines changed

1 file changed

+24
-45
lines changed

README.md

Lines changed: 24 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ Available Commands:
112112
shell Start an interactive shell for MCP commands
113113
mock Create a mock MCP server with tools, prompts, and resources
114114
proxy Proxy MCP tool requests to shell scripts
115-
scan Scan for available MCP servers in various applications
116115
alias Manage MCP server aliases
116+
configs Manage MCP server configurations
117117
new Create a new MCP project component
118118
help Help about any command
119119
completion Generate the autocompletion script for the specified shell
@@ -122,6 +122,8 @@ Flags:
122122
-f, --format string Output format (table, json, pretty) (default "table")
123123
-h, --help help for mcp
124124
-p, --params string JSON string of parameters to pass to the tool (for call command) (default "{}")
125+
126+
Use "mcp [command] --help" for more information about a command.
125127
```
126128

127129
### Transport Options
@@ -238,50 +240,6 @@ mcp call resource:my-resource npx -y @modelcontextprotocol/server-filesystem ~
238240
mcp call prompt:my-prompt --params '{"name":"John"}' npx -y @modelcontextprotocol/server-filesystem ~
239241
```
240242

241-
#### Scan for MCP Servers
242-
243-
The scan command searches for MCP server configurations across multiple applications:
244-
245-
```bash
246-
# Scan for all MCP servers in supported applications
247-
mcp scan
248-
249-
# Display in JSON format grouped by application
250-
mcp scan -f json
251-
252-
# Display in colorized format (default)
253-
mcp scan -f table
254-
```
255-
256-
The scan command looks for MCP server configurations in:
257-
- Visual Studio Code
258-
- Visual Studio Code Insiders
259-
- Windsurf
260-
- Cursor
261-
- Claude Desktop
262-
263-
For each server, it displays:
264-
- Server source (application)
265-
- Server name
266-
- Server type (stdio or sse)
267-
- Command and arguments or URL
268-
- Environment variables (for stdio servers)
269-
- Headers (for sse servers)
270-
271-
Example output:
272-
```
273-
VS Code Insiders
274-
GitHub (stdio):
275-
docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server
276-
277-
Claude Desktop
278-
Proxy (stdio):
279-
mcp proxy start
280-
281-
My Files (stdio):
282-
npx -y @modelcontextprotocol/server-filesystem ~/
283-
```
284-
285243
### Interactive Shell
286244

287245
The interactive shell mode allows you to run multiple MCP commands in a single session:
@@ -447,6 +405,27 @@ Configurations are managed through a central registry in `$HOME/.mcpt/configs.js
447405

448406
The system automatically displays server configurations in a colorized format grouped by source, showing command-line or URL information, headers, and environment variables.
449407

408+
`mcp configs scan` command looks for MCP server configurations in:
409+
- Visual Studio Code
410+
- Visual Studio Code Insiders
411+
- Windsurf
412+
- Cursor
413+
- Claude Desktop
414+
415+
Example Output:
416+
```
417+
VS Code Insiders
418+
GitHub (stdio):
419+
docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server
420+
421+
Claude Desktop
422+
Proxy (stdio):
423+
mcp proxy start
424+
425+
My Files (stdio):
426+
npx -y @modelcontextprotocol/server-filesystem ~/
427+
```
428+
450429
## Server Modes
451430

452431
MCP Tools can operate as both a client and a server, with two server modes available:

0 commit comments

Comments
 (0)