mirror of
https://github.com/mcp-use/mcp-use.git
synced 2026-09-14 18:06:01 +08:00
Pietro Zullo
30b23271d5
* fix(python): respect configured inspector path * fix(python): treat inspector path as a base prefix * fix(python): format inspector fixes for ruff * fix(ci): run conformance with node 22 * fix(ci): fail conformance runs with empty results * chore(ci): drop inline conformance result validation * docs(python): clarify inspector path behavior
89 lines
3.2 KiB
Plaintext
89 lines
3.2 KiB
Plaintext
---
|
|
title: "Inspector UI"
|
|
description: "Built-in web interface for real-time server monitoring and debugging"
|
|
icon: "monitor"
|
|
---
|
|
<Card title="" img="https://cdn.mcp-use.com/docs/python/mcp_use_inspector.gif" horizontal="true"/>
|
|
|
|
<Info>
|
|
The mcp-use server framework includes a built-in Inspector UI, a web-based interface for real-time monitoring, debugging, and interaction with your MCP server. It provides a quick way to see server status, available tools, resources, and logs.
|
|
</Info>
|
|
|
|
## What is the Inspector UI?
|
|
|
|
The Inspector UI is a built-in web interface that provides real-time monitoring and debugging capabilities for your MCP server. It's a visual dashboard that shows server status, available tools, resources, and logs. It also includes a BYOK (Bring Your Own Key) chat interface for interactive communication with your MCP server.
|
|
|
|
## Why Use the Inspector UI?
|
|
|
|
The Inspector UI makes it easier to:
|
|
- **Debug issues** by seeing real-time logs and server status
|
|
- **Test tools** interactively without writing client code
|
|
- **Monitor performance** with live metrics and request tracking
|
|
- **Explore capabilities** by browsing available tools and resources
|
|
- **Chat with your server** using the built-in BYOK chat interface
|
|
|
|
<Warning>
|
|
The Inspector UI is only available when the server is running in **debug mode**. It is automatically disabled in production for security reasons.
|
|
</Warning>
|
|
|
|
## Accessing the Inspector
|
|
|
|
Once your mcp-use server is running in debug mode, you can access the Inspector UI in your browser.
|
|
|
|
By default, the Inspector lives at `/inspector`.
|
|
|
|
For a server running on `http://localhost:3001`, the default Inspector URL is:
|
|
`http://localhost:3001/inspector`
|
|
|
|
### `inspector_path` semantics
|
|
|
|
`inspector_path` is a **base prefix**, not a replacement for `/inspector`.
|
|
|
|
- `inspector_path="/"` or omitting it keeps the default route at `/inspector`
|
|
- `inspector_path="/mcp"` mounts the Inspector at `/mcp/inspector`
|
|
- `inspector_path="/internal/debug"` mounts the Inspector at `/internal/debug/inspector`
|
|
- `inspector_path="/mcp/inspector"` is still accepted for backward compatibility and normalizes to the same final route
|
|
|
|
This is independent from `mcp_path`:
|
|
|
|
- `mcp_path="/mcp"` and default `inspector_path` gives you `/mcp` for MCP traffic and `/inspector` for the Inspector
|
|
- `mcp_path="/mcp"` and `inspector_path="/mcp"` gives you `/mcp` for MCP traffic and `/mcp/inspector` for the Inspector
|
|
|
|
```python
|
|
from mcp_use.server import MCPServer
|
|
|
|
server = MCPServer(
|
|
name="my-server",
|
|
debug=True,
|
|
mcp_path="/mcp",
|
|
inspector_path="/mcp",
|
|
)
|
|
|
|
# MCP endpoint: /mcp
|
|
# Inspector endpoint: /mcp/inspector
|
|
```
|
|
|
|
## Demo
|
|
<img src="https://cdn.mcp-use.com/docs/python/mcp_use_inspector.gif" alt="Description of the GIF" />
|
|
|
|
## Configuration
|
|
|
|
The Inspector UI is automatically enabled when running in debug mode and disabled in production.
|
|
|
|
```python
|
|
from mcp_use.server import MCPServer
|
|
|
|
server = MCPServer(
|
|
name="my-server",
|
|
debug=True,
|
|
inspector_path="/internal",
|
|
)
|
|
|
|
# Inspector endpoint: /internal/inspector
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
- [Running the Server](/python/server/running) - How to run your server
|
|
- [Quickstart Guide](/python/getting-started/quickstart) - Build your first server
|