diff --git a/src/create_mcp_server/template/README.md.jinja2 b/src/create_mcp_server/template/README.md.jinja2 index 7abfe66..c35655d 100644 --- a/src/create_mcp_server/template/README.md.jinja2 +++ b/src/create_mcp_server/template/README.md.jinja2 @@ -24,14 +24,22 @@ The server implements one tool: - Takes "name" and "content" as required string arguments - Updates server state and notifies clients of resource changes -## Install +## Configuration -### Claude Desktop +[TODO: Add configuration details specific to your implementation] + +## Quickstart + +### Install + +#### Claude Desktop On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json` On Windows: `%APPDATA%/Claude/claude_desktop_config.json` -``` +
+ Development/Unpublished Servers Configuration + ``` "mcpServers": { "{{server_name}}": { "command": "uv", @@ -43,9 +51,51 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json` ] } } + ``` +
+ +
+ Published Servers Configuration + ``` + "mcpServers": { + "{{server_name}}": { + "command": "uvx", + "args": [ + "{{server_name}}" + ] + } + } + ``` +
+ +## Development + +### Building and Publishing + +To prepare the package for distribution: + +1. Sync dependencies and update lockfile: +```bash +uv sync ``` -## Develop and Debug +2. Build package distributions: +```bash +uv build +``` + +This will create source and wheel distributions in the `dist/` directory. + +3. Publish to PyPI: +```bash +uv publish +``` + +Note: You'll need to set PyPI credentials via environment variables or command flags: +- Token: `--token` or `UV_PUBLISH_TOKEN` +- Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD` + +### Debugging Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).