🛰️ MCP 支持
本文档解释了如何轻松设置和部署由 Open WebUI 提供的 MCP(模型上下文协议)-到-OpenAPI 代理服务器 (mcpo)。了解如何通过适用于最终用户和开发人员的标准、熟悉的 OpenAPI 端点,轻松公开基于 MCP 的工具服务器。
📌 什么是 MCP 代理服务器?
MCP-到-OpenAPI 代理服务器允许您直接通过标准 REST/OpenAPI API 使用基于 MCP(模型上下文协议)实现的工具服务器——无需管理不熟悉或复杂的自定义协议。如果您是最终用户或应用程序开发人员,这意味着您可以轻松地通过熟悉的类 REST 端点与强大的基于 MCP 的工具进行交互。
💡 为什么要使用 mcpo?
尽管 MCP 工具服务器功能强大且灵活,但它们通常通过标准输入/输出 (stdio) 进行通信——通常运行在您的本地机器上,可以轻松访问您的文件系统、环境和其他本地系统功能。
这是优点——也是局限。
如果您想在云端部署您的主界面(如 Open WebUI),您会很快遇到一个问题:您的云实例无法通过 stdio 直接与运行在您本地机器上的 MCP 服务器通信。
MCP 服务器通常依赖原始 stdio 通信,这会带来:
- 🔓 跨环境固有的不安全性
- ❌ 与大多数现代工具、UI 或平台不兼容
- 🧩 缺少身份验证、文档和错误处理等关键功能
mcpo 代理自动消除了这些问题
- ✅ 即时兼容现有 OpenAPI 工具、SDK 和客户端
- 🛡 为您的工具封装安全、可扩展且基于标准的 HTTP 端点
- 🧠 为每个工具自动生成交互式 OpenAPI 文档,完全无需配置
- 🔌 使用纯 HTTP——无需套接字设置、守护进程管理或平台特定的粘合代码
因此,尽管添加 mcpo 最初可能看起来“只是多了一层”——实际上,它简化了一切,同时为您带来了:
- 更好的集成 ✅
- 更好的安全性 ✅
- 更好的可扩展性 ✅
- 更满意的开发者和用户 ✅
✨ 有了 mcpo,您本地专属的 AI 工具将变得云端就绪、UI 友好,并能即时互操作——无需更改工具服务器的任何一行代码。
✅ 快速开始:在本地运行代理
以下是使用轻量、易用的工具 mcpo (GitHub 仓库) 启动 MCP-到-OpenAPI 代理服务器的简单方法:
-
先决条件
- 已安装 Python 3.8+ 及
pip
。 - MCP 兼容应用程序(例如:
mcp-server-time
) - (可选但推荐)安装
uv
以实现更快的启动和零配置便利。
- 已安装 Python 3.8+ 及
-
安装 mcpo
使用 uv(推荐)
uvx mcpo --port 8000 -- your_mcp_server_command
或者使用 pip
pip install mcpo
mcpo --port 8000 -- your_mcp_server_command
- 🚀 运行代理服务器
要启动您的 MCP-到-OpenAPI 代理服务器,您需要一个 MCP 兼容的工具服务器。如果您还没有,MCP 社区提供了各种即用型 MCP 服务器实现。
✨ 在哪里找到 MCP 服务器?
您可以在以下示例仓库中找到官方支持的 MCP 服务器:
例如,流行的 Time MCP 服务器 在此处有文档说明,并且通常在 README 中,在提供的 MCP 配置内清晰地引用。具体来说,README 指出:
添加到您的 Claude 设置中
"mcpServers": {
"time": {
"command": "uvx",
"args": ["mcp-server-time", "--local-timezone=America/New_York"]
}
}
🔑 将此 MCP 设置转换为快速本地代理命令
您可以轻松地通过 MCP-到-OpenAPI 代理 (mcpo
) 直接运行推荐的 MCP 服务器 (mcp-server-time
),如下所示:
uvx mcpo --port 8000 -- uvx mcp-server-time --local-timezone=America/New_York
就是这样!您现在正在本地运行 MCP-到-OpenAPI 代理,并通过标准 OpenAPI 端点公开强大的 MCP 时间服务器,可在以下地址访问:
- 📖 交互式 OpenAPI 文档:
https://:8000/docs
您可以随意将 uvx mcp-server-time --local-timezone=America/New_York
替换为官方仓库中其他可用 MCP 实现的您首选的 MCP 服务器命令。
🤝 在启动服务器后,要与 Open WebUI 集成,请查阅我们的文档。
🚀 访问生成的 API
MCP 代理 (mcpo
) 启动后会自动:
- 动态发现 MCP 工具并生成 REST 端点。
- 创建可在以下地址访问的交互式、人类可读的 OpenAPI 文档:
https://:8000/docs
只需通过 HTTP 客户端、AI 代理或您偏好的其他 OpenAPI 工具直接调用自动生成的 API 端点即可。
📖 最终用户工作流程示例
假设您已启动上述服务器命令 (uvx mcp-server-time
):
- 访问您的本地 API 文档:
https://:8000/docs
。 - 选择一个生成的端点(例如
/get_current_time
)并使用提供的交互式表单。 - 点击“执行”并立即接收您的响应。
没有复杂的设置——只有即时可用的 REST API。
🚀 生产部署(示例)
部署您的 MCP-到-OpenAPI 代理(由 mcpo 提供支持)非常简单。以下是如何轻松将其 Docker 化并部署到云或 VPS 解决方案:
🐳 使用 mcpo 将您的代理服务器 Docker 化
- Dockerfile 示例
在您的部署目录中创建以下 Dockerfile
:
FROM python:3.11-slim
WORKDIR /app
RUN pip install mcpo uv
# Replace with your MCP server command; example: uvx mcp-server-time
CMD ["uvx", "mcpo", "--host", "0.0.0.0", "--port", "8000", "--", "uvx", "mcp-server-time", "--local-timezone=America/New_York"]
- 本地构建并运行容器
docker build -t mcp-proxy-server .
docker run -d -p 8000:8000 mcp-proxy-server
- 部署您的容器
推送到 DockerHub 或其他注册表
docker tag mcp-proxy-server yourdockerusername/mcp-proxy-server:latest
docker push yourdockerusername/mcp-proxy-server:latest
使用 Docker Compose、Kubernetes YAML 清单或您喜欢的云容器服务(AWS ECS、Azure Container Instances、Render.com 或 Heroku)进行部署。
✔️ 您的生产 MCP 服务器现在可以通过 REST API 轻松访问!
🧑💻 技术细节和背景
🍃 工作原理(技术概述)
-
动态模式发现和端点: 在服务器启动时,代理连接到 MCP 服务器以查询可用工具。它根据 MCP 工具模式自动构建 FastAPI 端点,创建简洁明了的 REST 端点。
-
OpenAPI 自动文档: 生成的端点通过 FastAPI 内置的 Swagger UI (
/docs
) 无缝地进行文档化和可用。无需额外编写文档。 -
异步且高性能: 基于强大的异步库构建,确保并发用户的速度和可靠性。
📚 幕后:
- FastAPI(自动路由和文档生成)
- MCP 客户端(标准 MCP 集成和模式发现)
- 基于 HTTP 的标准 JSON(易于集成)
⚡️ 为什么 MCP-到-OpenAPI 代理更胜一筹?
通过代理方式利用 OpenAPI 来使用 MCP 服务器显著更优越,这也是 Open WebUI 积极支持它的原因:
- 用户友好和熟悉的界面:无需自定义客户端;只需您已经了解的 HTTP REST 端点。
- 即时集成:立即兼容数千个现有 REST/OpenAPI 工具、SDK 和服务。
- 强大且自动的文档:内置的 Swagger UI 文档自动生成,始终准确并持续维护。
- 无新协议开销:无需直接处理 MCP 特定协议的复杂性和套接字通信问题。
- 经过实战检验的安全性与稳定性:继承了成熟的 HTTPS 传输、标准身份验证方法(JWT、API 密钥)、可靠的异步库以及 FastAPI 经过验证的健壮性。
- 面向未来:MCP 代理使用现有、稳定、标准的 REST/OpenAPI 格式,确保获得长期的社区支持和发展。
🌟 总而言之: MCP-到-OpenAPI 通过直观、可靠且可扩展的 REST 端点,使您强大的基于 MCP 的 AI 工具能够广泛访问。Open WebUI 骄傲地支持并推荐这种一流的方法。
📢 社区与支持
- 如有问题、建议或功能请求,请使用我们的 GitHub 问题追踪器 或加入我们的 社区讨论。
祝您集成愉快!🌟🚀