Skip to content

Commit edcca56

Browse files
author
LittleCoinCoin
committed
docs(mcp): correct command examples and enhance configuration guidance
Fix inaccurate CLI command examples and improve user guidance: - Correct list commands: * Replace 'hatch mcp list --host claude-desktop' with 'hatch mcp list hosts' * Replace 'hatch mcp list --all-hosts' with 'hatch mcp list servers [--env]' - Fix remove commands: * Update to proper 'hatch mcp remove server <name> --host <host>' syntax * Add 'hatch mcp remove host <host>' for complete host removal - Add mutual exclusivity documentation: * Explain --command vs --url flag requirements * Clarify local vs remote server configuration * Prevent common user configuration errors All command examples now match actual CLI implementation and have been tested for accuracy. Enhanced documentation prevents user confusion and provides clear guidance for both local and remote server configuration. Improves user experience by ensuring documentation accuracy and providing comprehensive configuration guidance.
1 parent 7d385e6 commit edcca56

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

docs/articles/users/MCPHostConfiguration.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,14 @@ hatch mcp configure api-service \
4747
View servers configured on a specific host:
4848

4949
```bash
50-
# List servers on Claude Desktop
51-
hatch mcp list --host claude-desktop
50+
# List available host platforms
51+
hatch mcp list hosts
5252

53-
# List servers on all available hosts
54-
hatch mcp list --all-hosts
53+
# List configured servers from current environment
54+
hatch mcp list servers
55+
56+
# List servers from specific environment
57+
hatch mcp list servers --env production
5558
```
5659

5760
### Remove a Server
@@ -60,14 +63,24 @@ Remove an MCP server from a host:
6063

6164
```bash
6265
# Remove server from specific host
63-
hatch mcp remove weather-server --host claude-desktop
66+
hatch mcp remove server weather-server --host claude-desktop
6467

6568
# Remove server from all hosts
66-
hatch mcp remove weather-server --all-hosts
69+
hatch mcp remove server weather-server --host all
70+
71+
# Remove entire host configuration
72+
hatch mcp remove host claude-desktop
6773
```
6874

6975
## Configuration Types
7076

77+
**Important**: Each server must be configured as either local (using `--command`) or remote (using `--url`), but not both. These options are mutually exclusive:
78+
79+
- **Local servers**: Use `--command` and optionally `--args` and `--env`
80+
- **Remote servers**: Use `--url` and optionally `--headers`
81+
82+
Attempting to use both `--command` and `--url` will result in an error.
83+
7184
### Local Servers
7285

7386
Local servers run as processes on your machine:

0 commit comments

Comments
 (0)