Skip to content

Commit fb7f441

Browse files
authored
docs(example): show command to run MCP Inspector (#42)
* docs(example): show command to run MCP Inspector * use -y to run the inspector * docs(examples): update READMEs with MCP Inspector usage
1 parent f66d53b commit fb7f441

File tree

4 files changed

+32
-0
lines changed

4 files changed

+32
-0
lines changed

examples/hello-world-mcp-server-core/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@ cargo build -p hello-world-mcp-server-core --release
2929
3. After building the project, the binary will be located at `target/release/hello-world-mcp-server-core`
3030
You can test it with [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector), or alternatively, use it with any MCP client you prefer.
3131

32+
```bash
33+
npx -y @modelcontextprotocol/inspector ./target/release/hello-world-mcp-server-core
34+
```
35+
36+
```
37+
Starting MCP inspector...
38+
⚙ Proxy server listening on port 6277
39+
🔍 MCP Inspector is up and running at http://127.0.0.1:6274 🚀
40+
```
41+
3242
Here you can see it in action :
3343

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

examples/hello-world-mcp-server/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ cargo build -p hello-world-mcp-server --release
2828
3. After building the project, the binary will be located at `target/release/hello-world-mcp-server`
2929
You can test it with [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector), or alternatively, use it with any MCP client you prefer.
3030

31+
```bash
32+
npx -y @modelcontextprotocol/inspector ./target/release/hello-world-mcp-server
33+
```
34+
35+
```
36+
Starting MCP inspector...
37+
⚙ Proxy server listening on port 6277
38+
🔍 MCP Inspector is up and running at http://127.0.0.1:6274 🚀
39+
```
40+
3141
Here you can see it in action :
3242

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

examples/hello-world-server-core-sse/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ cargo run -p hello-world-server-sse --release
2929
By default, the SSE endpoint is accessible at `http://127.0.0.1:8080/sse`.
3030
You can test it with [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector), or alternatively, use it with any MCP client you prefer.
3131

32+
```bash
33+
npx -y @modelcontextprotocol/inspector
34+
```
35+
36+
Then visit: http://localhost:6274/?transport=sse&serverUrl=http://localhost:8080/sse
37+
3238
Here you can see it in action :
3339

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

examples/hello-world-server-sse/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ cargo run -p hello-world-server-sse --release
2828
By default, the SSE endpoint is accessible at `http://127.0.0.1:8080/sse`.
2929
You can test it with [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector), or alternatively, use it with any MCP client you prefer.
3030

31+
```bash
32+
npx -y @modelcontextprotocol/inspector
33+
```
34+
35+
Then visit: http://localhost:6274/?transport=sse&serverUrl=http://localhost:8080/sse
36+
3137
Here you can see it in action :
3238

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

0 commit comments

Comments
 (0)