Skip to content

docs(example): show command to run MCP Inspector #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 27, 2025
Merged

docs(example): show command to run MCP Inspector #42

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1192208
docs(example): show command to run MCP Inspector
cablehead May 26, 2025
9bbbb0b
use -y to run the inspector
cablehead May 27, 2025
ce8093a
docs(examples): update READMEs with MCP Inspector usage
cablehead May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions examples/hello-world-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,19 @@ cargo build -p hello-world-mcp-server --release
3. After building the project, the binary will be located at `target/release/hello-world-mcp-server`
You can test it with [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector), or alternatively, use it with any MCP client you prefer.

```bash
npx @modelcontextprotocol/inspector ./target/release/hello-world-mcp-server
Copy link
Member

@hashemix hashemix May 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small suggestion , I think it is better to also add -y to it to avoid prompting the user
( terminal output needs to be updated accordingly too)

npx -y @modelcontextprotocol/inspector ./target/release/hello-world-mcp-server

```

```
Need to install the following packages:
@modelcontextprotocol/[email protected]
Ok to proceed? (y)
Starting MCP inspector...
⚙ Proxy server listening on port 6277
🔍 MCP Inspector is up and running at http://127.0.0.1:6274 🚀
```

Here you can see it in action :

![hello-world-mcp-server](../../assets/examples/hello-world-mcp-server.gif)