From 7cfba3e1433865887a936fb8c553a3f72c22e0cf Mon Sep 17 00:00:00 2001
From: Justin Spahr-Summers <justin@anthropic.com>
Date: Wed, 20 Nov 2024 12:27:35 +0000
Subject: [PATCH] Add generated README

---
 template/README.md.ejs | 70 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 template/README.md.ejs

diff --git a/template/README.md.ejs b/template/README.md.ejs
new file mode 100644
index 0000000..ae94532
--- /dev/null
+++ b/template/README.md.ejs
@@ -0,0 +1,70 @@
+# <%= 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):
+
+```bash
+npx @modelcontextprotocol/inspector /path/to/<%= name %>/build/index.js
+```
+
+The Inspector will provide a URL to access debugging tools in your browser.