Skip to content

Commit 42c4cbd

Browse files
committed
docs: fix configuration paths and misleading examples
- Fix Claude Desktop config paths for all platforms (macOS, Linux, Windows) * macOS: ~/Library/Application Support/Claude/claude_desktop_config.json * Linux: ~/.config/Claude/claude_desktop_config.json * Windows: %APPDATA%\Claude\claude_desktop_config.json - Update server name from 'go-zero-mcp' to 'mcp-zero' for consistency - Add GOCTL_PATH to all platform configurations - Clarify 'Adding an Endpoint' workflow (manual edit + regenerate, not automatic) - Remove misleading suggestion that endpoints can be added automatically
1 parent ffe46ab commit 42c4cbd

File tree

3 files changed

+37
-17
lines changed

3 files changed

+37
-17
lines changed

QUICKSTART.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,16 @@ curl http://localhost:8080/ping
118118

119119
### Adding an Endpoint
120120

121-
Ask Claude:
121+
To add new endpoints, you'll need to:
122+
123+
1. Edit the `.api` file manually to add your endpoint
124+
2. Regenerate code from the updated spec:
122125

123126
```
124-
Add a new endpoint GET /api/user/:id to my userservice
127+
Generate code from the userservice.api file in ./userservice
125128
```
126129

127-
mcp-zero will update the API specification and regenerate code.
130+
Claude will use the `generate_api_from_spec` tool to regenerate the service with your new endpoints.
128131

129132
### Creating an RPC Service
130133

readme.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,34 +65,48 @@ go build -o go-zero-mcp main.go
6565

6666
Add this configuration to your Claude Desktop MCP settings:
6767

68-
### macOS/Linux
69-
Edit `~/.config/claude/mcp_settings.json`:
68+
### macOS
69+
Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
7070

7171
```json
7272
{
7373
"mcpServers": {
74-
"go-zero-mcp": {
75-
"command": "/path/to/your/go-zero-mcp",
76-
"args": [],
74+
"mcp-zero": {
75+
"command": "/path/to/your/mcp-zero",
7776
"env": {
78-
"PATH": "/usr/local/bin:/usr/bin:/bin"
77+
"GOCTL_PATH": "/Users/yourname/go/bin/goctl"
78+
}
79+
}
80+
}
81+
}
82+
```
83+
84+
### Linux
85+
Edit `~/.config/Claude/claude_desktop_config.json`:
86+
87+
```json
88+
{
89+
"mcpServers": {
90+
"mcp-zero": {
91+
"command": "/path/to/your/mcp-zero",
92+
"env": {
93+
"GOCTL_PATH": "/usr/local/bin/goctl"
7994
}
8095
}
8196
}
8297
}
8398
```
8499

85100
### Windows
86-
Edit `%APPDATA%/Claude/mcp_settings.json`:
101+
Edit `%APPDATA%\Claude\claude_desktop_config.json`:
87102

88103
```json
89104
{
90105
"mcpServers": {
91-
"go-zero-mcp": {
92-
"command": "C:\\path\\to\\your\\go-zero-mcp.exe",
93-
"args": [],
106+
"mcp-zero": {
107+
"command": "C:\\path\\to\\your\\mcp-zero.exe",
94108
"env": {
95-
"PATH": "C:\\Go\\bin;C:\\Program Files\\Go\\bin"
109+
"GOCTL_PATH": "C:\\Go\\bin\\goctl.exe"
96110
}
97111
}
98112
}

specs/quickstart.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,16 @@ curl http://localhost:8080/ping
118118

119119
### Adding an Endpoint
120120

121-
Ask Claude:
121+
To add new endpoints, you'll need to:
122+
123+
1. Edit the `.api` file manually to add your endpoint
124+
2. Regenerate code from the updated spec:
122125

123126
```
124-
Add a new endpoint GET /api/user/:id to my userservice
127+
Generate code from the userservice.api file in ./userservice
125128
```
126129

127-
mcp-zero will update the API specification and regenerate code.
130+
Claude will use the `generate_api_from_spec` tool to regenerate the service with your new endpoints.
128131

129132
### Creating an RPC Service
130133

0 commit comments

Comments
 (0)