Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 37 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,46 @@

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

It can be run easily from `npx`:
![MCP Inspector Screenshot](mcp-inspector.png)

## 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
```
npx @modelcontextprotocol/inspector

You can also pass arguments along which will get passed as arguments to your MCP server:

```
npx @modelcontextprotocol/inspector build/index.js arg1 arg2 ...
```

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
```

### 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
```
This starts a localhost web server on port 5173. You can then visit http://localhost:5173/ to interact with the tool.

## License

Expand Down
Binary file added mcp-inspector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.