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:
24
24
- Takes "name" and "content" as required string arguments
25
25
- Updates server state and notifies clients of resource changes
26
26
27
- ## Install
27
+ ## Configuration
28
28
29
- ### Claude Desktop
29
+ [TODO: Add configuration details specific to your implementation]
30
+
31
+ ## Quickstart
32
+
33
+ ### Install
34
+
35
+ #### Claude Desktop
30
36
31
37
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
32
38
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
33
39
34
- ```
40
+ <details >
41
+ <summary >Development/Unpublished Servers Configuration</summary >
42
+ ```
35
43
"mcpServers": {
36
44
"{{server_name}}": {
37
45
"command": "uv",
@@ -43,9 +51,51 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
43
51
]
44
52
}
45
53
}
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
46
92
```
47
93
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
49
99
50
100
Since MCP servers run over stdio, debugging can be challenging. For the best debugging
51
101
experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
You can’t perform that action at this time.
0 commit comments