Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/modelcontextprotocol/inspector
Visual testing tool for MCP servers
https://github.com/modelcontextprotocol/inspector
Last synced: 3 days ago
JSON representation
Visual testing tool for MCP servers
- Host: GitHub
- URL: https://github.com/modelcontextprotocol/inspector
- Owner: modelcontextprotocol
- License: mit
- Created: 2024-10-03T21:47:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-22T12:02:59.000Z (10 days ago)
- Last Synced: 2025-01-23T03:09:40.222Z (10 days ago)
- Language: TypeScript
- Homepage: https://modelcontextprotocol.io
- Size: 1010 KB
- Stars: 226
- Watchers: 14
- Forks: 46
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-mcp - Server inspector - Visual testing tool for MCP servers. (Tools / Official)
- awesome-mcp - Server inspector - Official - Visual testing tool for MCP servers (Go)
README
# MCP Inspector
The MCP inspector is a developer tool for testing and debugging MCP servers.
## Running the Inspector
### From an MCP server repository
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`:
```bash
npx @modelcontextprotocol/inspector build/index.js
```
You can pass both arguments and environment variables to your MCP server. Arguments are passed directly to your server, while environment variables can be set using the `-e` flag:
```bash
# Pass arguments only
npx @modelcontextprotocol/inspector build/index.js arg1 arg2
# Pass environment variables only
npx @modelcontextprotocol/inspector -e KEY=value -e KEY2=$VALUE2 build/index.js
# Pass both environment variables and arguments
npx @modelcontextprotocol/inspector -e KEY=value -e KEY2=$VALUE2 build/index.js arg1 arg2
# Use -- to separate inspector flags from server arguments
npx @modelcontextprotocol/inspector -e KEY=$VALUE -- build/index.js -e server-flag
```
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:
```bash
CLIENT_PORT=8080 SERVER_PORT=9000 npx @modelcontextprotocol/inspector build/index.js
```
For more details on ways to use the inspector, see the [Inspector section of the MCP docs site](https://modelcontextprotocol.io/docs/tools/inspector). For help with debugging, see the [Debugging guide](https://modelcontextprotocol.io/docs/tools/debugging).
### From this repository
If you're working on the inspector itself:
Development mode:
```bash
npm run dev
```
Production mode:
```bash
npm run build
npm start
```
## License
This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.