Skip to content

Commit 695da34

Browse files
committed
clarify readme
1 parent 4862aa7 commit 695da34

File tree

2 files changed

+35
-3
lines changed

2 files changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,44 @@
22

33
The MCP inspector is a developer tool for testing and debugging MCP servers.
44

5-
It can be run easily from `npx`:
5+
![MCP Inspector Screenshot](mcp-inspector.png)
6+
7+
## Running the Inspector
8+
9+
### From an MCP server repository
10+
11+
To inspect an MCP server implementation, there's no need to clone this repo. Instead, use `npx`. For example, if your server is built at `build/index.js`:
12+
13+
```bash
14+
npx @modelcontextprotocol/inspector build/index.js
15+
```
16+
17+
You can also pass arguments along which will get passed as arguments to your MCP server:
618

719
```
8-
npx @modelcontextprotocol/inspector
20+
npx @modelcontextprotocol/inspector build/index.js arg1 arg2 ...
21+
```
22+
23+
The inspector runs both a client UI and an MCP proxy server:
24+
- Client UI: http://localhost:5173 (configurable via `CLIENT_PORT`) - open this in your browser
25+
- Proxy Server: http://localhost:3000 (configurable via `SERVER_PORT`) - used internally, no need to access directly
26+
27+
### From this repository
28+
29+
If you're working on the inspector itself:
30+
31+
Development mode:
32+
33+
```bash
34+
npm run dev
35+
```
36+
37+
Production mode:
38+
39+
```bash
40+
npm run build
41+
npm start
942
```
10-
This starts a localhost web server on port 5173. You can then visit http://localhost:5173/ to interact with the tool.
1143

1244
## License
1345

mcp-inspector.png

294 KB
Loading

0 commit comments

Comments
 (0)