Skip to content

Commit 6daf5ae

Browse files
committed
initial commit: example server from create-typescript-server
0 parents  commit 6daf5ae

File tree

6 files changed

+508
-0
lines changed

6 files changed

+508
-0
lines changed

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules/
2+
build/
3+
*.log
4+
.env*

README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# iterm-mcp MCP Server
2+
3+
A Model Context Protocol server
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+
"iterm-mcp": {
56+
"command": "/path/to/iterm-mcp/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), which is available as a package script:
65+
66+
```bash
67+
npm run inspector
68+
```
69+
70+
The Inspector will provide a URL to access debugging tools in your browser.

package-lock.json

+171
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "iterm-mcp",
3+
"version": "0.1.0",
4+
"description": "A Model Context Protocol server",
5+
"private": true,
6+
"type": "module",
7+
"bin": {
8+
"iterm-mcp": "./build/index.js"
9+
},
10+
"files": [
11+
"build"
12+
],
13+
"scripts": {
14+
"build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
15+
"prepare": "npm run build",
16+
"watch": "tsc --watch",
17+
"inspector": "npx @modelcontextprotocol/inspector build/index.js"
18+
},
19+
"dependencies": {
20+
"@modelcontextprotocol/sdk": "0.6.0"
21+
},
22+
"devDependencies": {
23+
"@types/node": "^20.11.24",
24+
"typescript": "^5.3.3"
25+
}
26+
}

0 commit comments

Comments
 (0)