Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.

Commit 7cfba3e

Browse files
committed
Add generated README
1 parent 0f9d240 commit 7cfba3e

1 file changed

Lines changed: 70 additions & 0 deletions

File tree

template/README.md.ejs

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# <%= name %> MCP Server
2+
3+
<%= description %>
4+
5+
This is a TypeScript-based MCP server that implements a simple notes system. It demonstrates core MCP concepts by providing:
6+
7+
- Resources representing text notes with URIs and metadata
8+
- Tools for creating new notes
9+
- Prompts for generating summaries of notes
10+
11+
## Features
12+
13+
### Resources
14+
- List and access notes via `note://` URIs
15+
- Each note has a title, content and metadata
16+
- Plain text mime type for simple content access
17+
18+
### Tools
19+
- `create_note` - Create new text notes
20+
- Takes title and content as required parameters
21+
- Stores note in server state
22+
23+
### Prompts
24+
- `summarize_notes` - Generate a summary of all stored notes
25+
- Includes all note contents as embedded resources
26+
- Returns structured prompt for LLM summarization
27+
28+
## Development
29+
30+
Install dependencies:
31+
```bash
32+
npm install
33+
```
34+
35+
Build the server:
36+
```bash
37+
npm run build
38+
```
39+
40+
For development with auto-rebuild:
41+
```bash
42+
npm run watch
43+
```
44+
45+
## Installation
46+
47+
To use with Claude Desktop, add the server config:
48+
49+
On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
50+
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
51+
52+
```json
53+
{
54+
"mcpServers": {
55+
"<%= name %>": {
56+
"command": "/path/to/<%= name %>/build/index.js"
57+
}
58+
}
59+
}
60+
```
61+
62+
### Debugging
63+
64+
Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector):
65+
66+
```bash
67+
npx @modelcontextprotocol/inspector /path/to/<%= name %>/build/index.js
68+
```
69+
70+
The Inspector will provide a URL to access debugging tools in your browser.

0 commit comments

Comments
 (0)