Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.

Commit eed5b35

Browse files
committed
Add templated README to projects
1 parent 84c807a commit eed5b35

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

src/create_mcp_server/template/README.md.jinja2

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,6 @@ The server implements one tool:
2828

2929
### Claude Desktop
3030

31-
Run
32-
```
33-
mcp setup --app Claude
34-
```
35-
36-
or by editing
37-
3831
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
3932
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
4033

@@ -51,3 +44,16 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
5144
}
5245
}
5346
```
47+
48+
## Develop and Debug
49+
50+
Since MCP servers run over stdio, debugging can be challenging. For the best debugging
51+
experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
52+
53+
You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:
54+
55+
```bash
56+
npx @modelcontextprotocol/inspector uv --directory {{server_directory}} run {{server_name}}
57+
```
58+
59+
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

0 commit comments

Comments
 (0)