Merge pull request #476 from olaservo/clarify-proxy-role-in-readme

Add simple architecture overview with note on proxy role
This commit is contained in:
Ola Hungerford 2025-05-30 16:44:28 -07:00 • committed by GitHub
commit bf85cebb2f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -4,6 +4,15 @@ The MCP inspector is a developer tool for testing and debugging MCP servers.
![MCP Inspector Screenshot](https://raw.githubusercontent.com/modelcontextprotocol/inspector/main/mcp-inspector.png)
## Architecture Overview
The MCP Inspector consists of two main components that work together:
- **MCP Inspector Client (MCPI)**: A React-based web UI that provides an interactive interface for testing and debugging MCP servers
- **MCP Proxy (MCPP)**: A Node.js server that acts as a protocol bridge, connecting the web UI to MCP servers via various transport methods (stdio, SSE, streamable-http)
Note that the proxy is not a network proxy for intercepting traffic. Instead, it functions as both an MCP client (connecting to your MCP server) and an HTTP server (serving the web UI), enabling browser-based interaction with MCP servers that use different transport protocols.
## Running the Inspector
### Requirements