Skip to content

Commit b825784

Browse files
authored
Merge pull request #75 from modelcontextprotocol/readmeupdate
clarify readme
2 parents 4862aa7 + 52c7e98 commit b825784

File tree

2 files changed

+37
-3
lines changed

2 files changed

+37
-3
lines changed

README.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,46 @@
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)
66

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
715
```
8-
npx @modelcontextprotocol/inspector
16+
17+
You can also pass arguments along which will get passed as arguments to your MCP server:
18+
19+
```
20+
npx @modelcontextprotocol/inspector build/index.js arg1 arg2 ...
21+
```
22+
23+
The inspector runs both a client UI (default port 5173) and an MCP proxy server (default port 3000). Open the client UI in your browser to use the inspector. You can customize the ports if needed:
24+
25+
```bash
26+
CLIENT_PORT=8080 SERVER_PORT=9000 npx @modelcontextprotocol/inspector build/index.js
27+
```
28+
29+
### From this repository
30+
31+
If you're working on the inspector itself:
32+
33+
Development mode:
34+
35+
```bash
36+
npm run dev
37+
```
38+
39+
Production mode:
40+
41+
```bash
42+
npm run build
43+
npm start
944
```
10-
This starts a localhost web server on port 5173. You can then visit http://localhost:5173/ to interact with the tool.
1145

1246
## License
1347

mcp-inspector.png

294 KB
Loading

0 commit comments

Comments
 (0)