This repository was archived by the owner on Mar 24, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +54
-4
lines changed
src/create_mcp_server/template Expand file tree Collapse file tree 1 file changed +54
-4
lines changed Original file line number Diff line number Diff line change @@ -24,14 +24,22 @@ The server implements one tool:
2424 - Takes "name" and "content" as required string arguments
2525 - Updates server state and notifies clients of resource changes
2626
27- ## Install
27+ ## Configuration
2828
29- ### Claude Desktop
29+ [TODO: Add configuration details specific to your implementation]
30+
31+ ## Quickstart
32+
33+ ### Install
34+
35+ #### Claude Desktop
3036
3137On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
3238On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
3339
34- ```
40+ <details >
41+ <summary >Development/Unpublished Servers Configuration</summary >
42+ ```
3543 "mcpServers": {
3644 "{{server_name}}": {
3745 "command": "uv",
@@ -43,9 +51,51 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
4351 ]
4452 }
4553 }
54+ ```
55+ </details >
56+
57+ <details >
58+ <summary >Published Servers Configuration</summary >
59+ ```
60+ "mcpServers": {
61+ "{{server_name}}": {
62+ "command": "uvx",
63+ "args": [
64+ "{{server_name}}"
65+ ]
66+ }
67+ }
68+ ```
69+ </details >
70+
71+ ## Development
72+
73+ ### Building and Publishing
74+
75+ To prepare the package for distribution:
76+
77+ 1. Sync dependencies and update lockfile:
78+ ```bash
79+ uv sync
80+ ```
81+
82+ 2. Build package distributions:
83+ ```bash
84+ uv build
85+ ```
86+
87+ This will create source and wheel distributions in the `dist/` directory.
88+
89+ 3. Publish to PyPI:
90+ ```bash
91+ uv publish
4692```
4793
48- ## Develop and Debug
94+ Note: You'll need to set PyPI credentials via environment variables or command flags:
95+ - Token: `--token` or `UV_PUBLISH_TOKEN`
96+ - Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD`
97+
98+ ### Debugging
4999
50100Since MCP servers run over stdio, debugging can be challenging. For the best debugging
51101experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
You can’t perform that action at this time.
0 commit comments