Swagger UI & Developer Tools for the Model Context Protocol
Project description
MCP Lens
MCP Lens is the Swagger UI equivalent for the Model Context Protocol (MCP). It provides a beautiful, interactive, and dark-themed web interface to explore, execute, and debug your MCP servers locally.
MCP Lens automatically intercepts calls to your MCP Server (using fastmcp), aggregates the schema of all available tools, resources, and prompts, and instantly spins up a local web UI.
🚀 Features
- 🛠 Tools Explorer: View all available tools, their JSON schemas, and test them with a live form. See execution traces and server responses.
- 📚 Resources Explorer: Browse all standard and dynamically paginated resources exposed by your MCP servers and inspect their values instantly.
- 💬 Prompts Explorer: View predefined prompt templates and invoke them dynamically to see exactly how they will format for LLMs.
- 📜 Request History: Keep a log of all executions along with performance metrics (execution time, status codes) and effortlessly replay them.
- 🔐 Multi-Server & Auth: Supports instrumenting multiple MCP servers concurrently and provides an interface for Bearer token authorizations per server.
📦 Installation
To use MCP Lens in your project, simply install it via pip:
pip install mcp-lens-ui
(Note: Ensure your MCP server is built using the fastmcp package.)
⚡ How to Use
Using MCP Lens is incredibly easy. Just import instrument from mcp_lens and wrap your FastMCP app instances.
Minimal Example (example.py)
Here is a full example showing how to create a basic weather MCP server and visualize it with MCP Lens.
import httpx
from fastmcp import FastMCP
from mcp_lens import instrument
app = FastMCP("OpenMeteo Weather")
@app.tool()
async def get_current_weather(latitude: float, longitude: float) -> str:
"""Get the current weather for a specific latitude and longitude. Uses Open-Meteo free API."""
url = f"https://api.open-meteo.com/v1/forecast?latitude={latitude}&longitude={longitude}¤t_weather=true"
async with httpx.AsyncClient() as client:
response = await client.get(url)
data = response.json()
if "current_weather" in data:
weather = data["current_weather"]
return f"Current temperature is {weather['temperature']}°C with wind speed {weather['windspeed']} km/h."
return "Weather data not available."
@app.resource("weather://about")
def about_weather_api() -> str:
"""Information about the weather data source."""
return "This weather data is provided by Open-Meteo, a free open-source weather API!"
@app.prompt()
def pack_for_trip(location_name: str) -> str:
"""Ask an AI to help pack for a trip based on the weather."""
return f"I am taking a trip to {location_name}. Can you check the weather forecast for that location and tell me what clothes I should pack?"
# The magic line that turns this into a Swagger UI!
instrument(app, ui=True, ui_port=8000)
if __name__ == "__main__":
print("Starting Open-Meteo Weather MCP Server...")
app.run()
When you run this script (python example.py), it will start your standard MCP server on stdio while launching the MCP Lens UI in the background on http://localhost:8000/mcp. Open that URL in your browser to start exploring!
🧠 Architecture
MCP Lens operates uniquely to coexist with your production stdio MCP server without interfering with how LLM clients communicate with it.
- Instrumentation layer: The
instrument(app)function reaches into the internal FastAPI router of theFastMCPapp. - Metadata Aggregation: It queries
/tools/list,/resources/list, and/prompts/listendpoints to build an internal state (AppState) of your MCP endpoints. - Background UI Server: It spawns an independent FastAPI application running a Uvicorn ASGI server in a separate daemon thread on a specified port (default
8000). - Vite React Frontend: The web UI (built with React + Tailwind + Vite) is bundled and served statically by the background FastAPI server. It communicates with the UI backend to dispatch simulated MCP requests dynamically.
Because the UI server runs on a completely distinct port/thread, your LLM client continues communicating natively over stdio undisturbed.
🤝 Contributing
Contributions are heavily welcomed! Whether it's fixing bugs, adding new features, or improving the frontend aesthetic.
- Fork the repository
- Create a feature branch
- Submit a Pull Request
📄 License
MIT License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcp_lens_ui-0.1.1.tar.gz.
File metadata
- Download URL: mcp_lens_ui-0.1.1.tar.gz
- Upload date:
- Size: 21.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f92677f5016e0b594eccf36d82f257e8d223ebd4728722e6d7eb23586f6fcaa
|
|
| MD5 |
25cfdec1560c0ade816546722f793f62
|
|
| BLAKE2b-256 |
e4af911acfe2ae307ddd63a817325c646b34576ee3a1769401d606f140675b8a
|
File details
Details for the file mcp_lens_ui-0.1.1-py3-none-any.whl.
File metadata
- Download URL: mcp_lens_ui-0.1.1-py3-none-any.whl
- Upload date:
- Size: 235.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
76a65e4e94da813451fd04a827adddd7d011d1e36168422d09eecb4c9d507ff1
|
|
| MD5 |
e14e4d64d7bf353e9657c50100165394
|
|
| BLAKE2b-256 |
fcf03365546aba9ea9e3330f4add8d5e2d618715969e231fc5c9e58fe31c7ea7
|