mirror of
https://github.com/open-webui/mcpo
synced 2025-06-26 18:26:58 +00:00
91 lines
2.4 KiB
Markdown
91 lines
2.4 KiB
Markdown
# ⚡️ mcpo
|
||
|
||
Expose any MCP tool as an OpenAPI-compatible HTTP server—instantly.
|
||
|
||
mcpo is a dead-simple proxy that takes an MCP server command and makes it accessible via standard RESTful OpenAPI, so your tools "just work" with LLM agents and apps expecting OpenAPI servers.
|
||
|
||
No custom protocol. No glue code. No hassle.
|
||
|
||
## 🤔 Why Use mcpo Instead of Native MCP?
|
||
|
||
MCP servers usually speak over raw stdio, which is:
|
||
|
||
- 🔓 Inherently insecure
|
||
- ❌ Incompatible with most tools
|
||
- 🧩 Missing standard features like docs, auth, error handling, etc.
|
||
|
||
mcpo solves all of that—without extra effort:
|
||
|
||
- ✅ Works instantly with OpenAPI tools, SDKs, and UIs
|
||
- 🛡 Adds security, stability, and scalability using trusted web standards
|
||
- 🧠 Auto-generates interactive docs for every tool, no config needed
|
||
- 🔌 Uses pure HTTP—no sockets, no glue code, no surprises
|
||
|
||
What feels like "one more step" is really fewer steps with better outcomes.
|
||
|
||
mcpo makes your AI tools usable, secure, and interoperable—right now, with zero hassle.
|
||
|
||
## 🚀 Quick Usage
|
||
|
||
We recommend using uv for lightning-fast startup and zero config.
|
||
|
||
```bash
|
||
uvx mcpo --port 8000 -- your_mcp_server_command
|
||
```
|
||
|
||
Or, if you’re using Python:
|
||
|
||
```bash
|
||
pip install mcpo
|
||
mcpo --port 8000 -- your_mcp_server_command
|
||
```
|
||
|
||
Example:
|
||
|
||
```bash
|
||
uvx mcpo --port 8000 -- uvx mcp-server-time --local-timezone=America/New_York
|
||
```
|
||
|
||
That’s it. Your MCP tool is now available at http://localhost:8000 with a generated OpenAPI schema — test it live at [http://localhost:8000/docs](http://localhost:8000/docs).
|
||
|
||
### 🔄 Using a Config File
|
||
|
||
You can serve multiple MCP tools via a single config file that follows the [Claude Desktop](https://modelcontextprotocol.io/quickstart/user) format:
|
||
|
||
Start via:
|
||
|
||
```bash
|
||
mcpo --config /path/to/config.json
|
||
```
|
||
|
||
Example config.json:
|
||
|
||
```json
|
||
{
|
||
"mcpServers": {
|
||
"memory": {
|
||
"command": "npx",
|
||
"args": ["-y", "@modelcontextprotocol/server-memory"]
|
||
},
|
||
"time": {
|
||
"command": "uvx",
|
||
"args": ["mcp-server-time", "--local-timezone=America/New_York"]
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
Each tool will be accessible under its own unique route, e.g.:
|
||
- http://localhost:8000/memory
|
||
- http://localhost:8000/time
|
||
|
||
Each with a dedicated OpenAPI schema and proxy handler. Access full schema UI at: `http://localhost:8000/<tool>/docs` (e.g. /memory/docs, /time/docs)
|
||
|
||
## 🔧 Requirements
|
||
|
||
- Python 3.8+
|
||
- uv (optional, but highly recommended for performance + packaging)
|
||
|
||
## 🪪 License
|
||
|
||
MIT |