create-python-server/src/create_mcp_server/template
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2024-11-19 22:57:31 +00:00
..
__init__.py.jinja2 fix 2024-11-18 21:28:23 +00:00
README.md.jinja2 Add templated README to projects 2024-11-19 22:57:31 +00:00
server.py.jinja2 fix 2024-11-18 21:28:23 +00:00

# {{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

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}}"
      ]
    }
  }
```

## Develop and Debug

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).

You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:

```bash
npx @modelcontextprotocol/inspector uv --directory {{server_directory}} run {{server_name}}
```

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.