create-typescript-server/template
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2024-11-25 12:26:32 -06:00
..
src Add shebang to template's index file 2024-11-20 14:42:42 +00:00
dotfile-gitignore Rename .gitignore to avoid xplat problems 2024-11-25 12:26:32 -06:00
package.json.ejs Don't actually need the cwd bits when the shebang works 2024-11-20 14:44:43 +00:00
README.md.ejs Add inspector package script 2024-11-20 14:42:35 +00:00
tsconfig.json Only one template for now 2024-11-18 13:28:59 +00:00

# <%= name %> MCP Server

<%= description %>

This is a TypeScript-based MCP server that implements a simple notes system. It demonstrates core MCP concepts by providing:

- Resources representing text notes with URIs and metadata
- Tools for creating new notes
- Prompts for generating summaries of notes

## Features

### Resources
- List and access notes via `note://` URIs
- Each note has a title, content and metadata
- Plain text mime type for simple content access

### Tools
- `create_note` - Create new text notes
  - Takes title and content as required parameters
  - Stores note in server state

### Prompts
- `summarize_notes` - Generate a summary of all stored notes
  - Includes all note contents as embedded resources
  - Returns structured prompt for LLM summarization

## Development

Install dependencies:
```bash
npm install
```

Build the server:
```bash
npm run build
```

For development with auto-rebuild:
```bash
npm run watch
```

## Installation

To use with Claude Desktop, add the server config:

On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`

```json
{
  "mcpServers": {
    "<%= name %>": {
      "command": "/path/to/<%= name %>/build/index.js"
    }
  }
}
```

### Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:

```bash
npm run inspector
```

The Inspector will provide a URL to access debugging tools in your browser.