Add templated README to projects
This commit is contained in:
parent
318a842fc9
commit
ae6e31527a
1 changed files with 70 additions and 9 deletions
53
src/create_mcp_server/template/README.md.jinja2
Normal file
53
src/create_mcp_server/template/README.md.jinja2
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# {{server_name}} MCP server
|
||||
|
||||
{{server_description}}
|
||||
|
||||
## Components
|
||||
|
||||
### Resources
|
||||
|
||||
The server implements a simple note storage system with:
|
||||
- Custom note:// URI scheme for accessing individual notes
|
||||
- Each note resource has a name, description and text/plain mimetype
|
||||
|
||||
### Prompts
|
||||
|
||||
The server provides a single prompt:
|
||||
- summarize-notes: Creates summaries of all stored notes
|
||||
- Optional "style" argument to control detail level (brief/detailed)
|
||||
- Generates prompt combining all current notes with style preference
|
||||
|
||||
### Tools
|
||||
|
||||
The server implements one tool:
|
||||
- add-note: Adds a new note to the server
|
||||
- Takes "name" and "content" as required string arguments
|
||||
- Updates server state and notifies clients of resource changes
|
||||
|
||||
## Install
|
||||
|
||||
### Claude Desktop
|
||||
|
||||
Run
|
||||
```
|
||||
mcp setup --app Claude
|
||||
```
|
||||
|
||||
or by editing
|
||||
|
||||
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
|
||||
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
|
||||
|
||||
```
|
||||
"mcpServers": {
|
||||
"{{server_name}}": {
|
||||
"command": "uv",
|
||||
"args": [
|
||||
"--directory",
|
||||
"{{server_directory}}",
|
||||
"run",
|
||||
"{{server_name}}"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
Loading…
Reference in a new issue