Merge pull request #5 from modelcontextprotocol/justin/inspector-shortcut

jspahrsummers · web-flow · commit 6b3fc69e672e · 2024-11-20T21:55:53.000Z
Add script shortcut to launch the inspector
diff --git a/template/README.md.ejs b/template/README.md.ejs
@@ -61,10 +61,10 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
 
 ### Debugging
 
-Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector):
+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
-npx @modelcontextprotocol/inspector /path/to/<%= name %>/build/index.js
+npm run inspector
 ```
 
 The Inspector will provide a URL to access debugging tools in your browser.
diff --git a/template/package.json.ejs b/template/package.json.ejs
@@ -13,7 +13,8 @@
   "scripts": {
     "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
     "prepare": "npm run build",
-    "watch": "tsc --watch"
+    "watch": "tsc --watch",
+    "inspector": "npx @modelcontextprotocol/inspector build/index.js"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "0.6.0"
diff --git a/template/src/index.ts.ejs b/template/src/index.ts.ejs
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 /**
  * This is a template MCP server that implements a simple notes system.
  * It demonstrates core MCP concepts like resources and tools by allowing:

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+#!/usr/bin/env node`
	`2`	`+`
`1`	`3`	`/**`
`2`	`4`	`* This is a template MCP server that implements a simple notes system.`
`3`	`5`	`* It demonstrates core MCP concepts like resources and tools by allowing:`