File tree Expand file tree Collapse file tree 3 files changed +55
-8
lines changed Expand file tree Collapse file tree 3 files changed +55
-8
lines changed Original file line number Diff line number Diff line change @@ -83,13 +83,59 @@ mcp add resource market-data
8383 mcp add tool report-generator
8484 ```
8585
86- 3 . Build and run:
86+ 3 . Build:
87+
8788 ``` bash
8889 npm run build
89- # or
90- npm run watch # for development
90+
9191 ```
9292
93+ 4 . Add to MCP Client (Read below for Claude Desktop example)
94+
95+ ## Using with Claude Desktop
96+
97+ ### Local Development
98+
99+ Add this configuration to your Claude Desktop config file:
100+
101+ ** MacOS** : \` ~ /Library/Application Support/Claude/claude_desktop_config.json\`
102+ ** Windows** : \` %APPDATA%/Claude/claude_desktop_config.json\`
103+
104+ \`\`\` json
105+ {
106+ "mcpServers": {
107+ "${projectName}": {
108+ "command": "node",
109+ "args":[ "/absolute/path/to/${projectName}/dist/index.js"]
110+ }
111+ }
112+ }
113+ \`\`\`
114+
115+ ### After Publishing
116+
117+ Add this configuration to your Claude Desktop config file:
118+
119+ ** MacOS** : \` ~ /Library/Application Support/Claude/claude_desktop_config.json\`
120+ ** Windows** : \` %APPDATA%/Claude/claude_desktop_config.json\`
121+
122+ \`\`\` json
123+ {
124+ "mcpServers": {
125+ "${projectName}": {
126+ "command": "npx",
127+ "args": [ "${projectName}"]
128+ }
129+ }
130+ }
131+ \`\`\`
132+
133+ ## Building and Testing
134+
135+ 1 . Make changes to your tools
136+ 2 . Run \` npm run build\` to compile
137+ 3 . The server will automatically load your tools on startup
138+
93139## Components Overview
94140
95141### 1. Tools (Main Component)
Original file line number Diff line number Diff line change @@ -113,7 +113,8 @@ Add this configuration to your Claude Desktop config file:
113113{
114114 "mcpServers": {
115115 "${ projectName } ": {
116- "command": "/absolute/path/to/${ projectName } /dist/index.js"
116+ "command": "node",
117+ "args":["/absolute/path/to/${ projectName } /dist/index.js"]
117118 }
118119 }
119120}
@@ -145,7 +146,7 @@ Add this configuration to your Claude Desktop config file:
145146
146147## Learn More
147148
148- - [MCP Framework Documentation ](https://github.com/your-org /mcp-framework)
149- - [Model Context Protocol Specification ](https://github .com/anthropics/model-context-protocol )
149+ - [MCP Framework Github ](https://github.com/QuantGeekDev /mcp-framework)
150+ - [MCP Framework Docs ](https://mcp-framework .com)
150151` ;
151152}
You can’t perform that action at this time.
0 commit comments