跳到主要内容

❓ 常见问题

🌐 问：为什么我的本地 OpenAPI 工具服务器无法从 WebUI 界面访问？​

答： 如果您的工具服务器在本地运行（例如 https://:8000），基于浏览器的客户端可能会因 CORS（跨域资源共享）策略而无法访问它。

确保在您的 OpenAPI 服务器中明确启用 CORS 头。例如，如果您正在使用 FastAPI，可以添加

from fastapi.middleware.cors import CORSMiddleware

app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],  # or specify your client origin
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

此外，如果 Open WebUI 通过 HTTPS 提供服务（例如 https://yourdomain.com），您的本地服务器必须满足以下条件之一

  • 从同一域通过 HTTPS 访问（例如 https://:8000）。
  • 或在本地主机 (127.0.0.1) 上运行，以允许浏览器放宽本地开发的安全限制。
  • 否则，由于混合内容规则，浏览器可能会阻止来自 HTTPS 页面的不安全请求到 HTTP API。

为了在生产环境中通过 HTTPS 安全地工作，您的 OpenAPI 服务器也必须通过 HTTPS 提供服务。

🚀 问：我的服务器实现需要使用 FastAPI 吗？​

答： 不需要！虽然我们的参考实现使用 FastAPI 编写以提高清晰度和易用性，但您可以使用任何能生成有效 OpenAPI (Swagger) 规范的框架或语言。一些常见的选择包括

  • FastAPI (Python)
  • Flask + Flask-RESTX (Python)
  • Express + Swagger UI (JavaScript/Node)
  • Spring Boot (Java)
  • Go 配备 Swag 或 Echo

关键是确保您的服务器暴露一个有效的 OpenAPI 模式，并且通过 HTTP(S) 进行通信。为所有端点设置自定义 operationId 非常重要。

🚀 问：为什么选择 OpenAPI 而不是 MCP？​

答： 在大多数实际场景中，OpenAPI 由于其简洁性、工具生态系统、稳定性和开发者友好性而优于 MCP。原因如下

  • ✅ 复用您现有代码：如果您之前构建过 REST API，那么您大部分工作已完成——无需重写您的逻辑。只需定义一个符合规范的 OpenAPI 规范，并将您现有代码作为工具服务器暴露即可。

    使用 MCP，您必须在一个自定义协议层中重新实现您的工具逻辑，这会重复工作并增加维护的范围。

  • 💼 更少的维护和调试：OpenAPI 自然地融入现代开发工作流程。您可以使用 Postman 测试端点，使用内置 API 检查日志，利用成熟的生态系统工具轻松排查故障——而且通常无需修改您的核心应用程序。

    MCP 引入了新的传输层、模式解析和运行时怪癖，所有这些都必须手动调试。

  • 🌍 基于标准：OpenAPI 在科技行业被广泛采用。其定义良好的结构意味着工具、代理和服务器可以立即互操作，无需特殊的桥接或翻译。

  • 🧰 更好的工具链：存在一个支持 OpenAPI 的完整工具生态系统——包括自动客户端/服务器生成、文档、验证、模拟、测试，甚至安全审计工具。

  • 🔐 一流的安全支持：OpenAPI 包括对 OAuth2、JWT、API 密钥和 HTTPS 等功能的原生支持——使得使用通用库和标准构建安全端点变得更容易。

  • 🧠 更多开发者已经了解它：使用 OpenAPI 意味着您正在使用后端团队、前端开发人员、DevOps 和产品工程师已经熟悉的语言。无需学习曲线或昂贵的入职培训。

  • 🔄 面向未来且可扩展：OpenAPI 随着 API 标准演进并保持向前兼容。相比之下，MCP 是定制的和实验性的——通常需要随着周围生态系统的变化而进行更改。

🧵 总结：OpenAPI 让您以更少的努力、更少的代码重复和更少的意外完成更多工作。它是一个生产就绪、开发者友好的途径，可为 LLM 工具提供支持——无需从头开始重新构建一切。

🔐 问：如何保护我的 OpenAPI 工具服务器？​

答： OpenAPI 支持行业标准安全机制，例如

  • OAuth 2.0
  • API 密钥头
  • JWT (JSON Web Token)
  • 基本认证

在生产环境中使用 HTTPS 加密传输中的数据，并根据需要使用适当的身份验证/授权方法限制端点。您可以使用 securitySchemes 字段将这些直接整合到您的 OpenAPI 模式中。

❓ 问：我可以使用 OpenAPI 工具服务器构建哪些类型的工具？​

答： 如果可以通过 REST API 暴露，您就可以构建它。常见的工具类型包括

  • 文件系统操作（读/写文件，列出目录）
  • Git 和文档仓库访问
  • 数据库查询或模式探索
  • 网页抓取器或摘要工具
  • 外部 SaaS 集成（例如 Salesforce、Jira、Slack）
  • LLM 附带的内存存储 / RAG 组件
  • 暴露给您的代理的安全内部微服务

🔌 问：我可以同时运行多个工具服务器吗？​

答： 当然可以。每个工具服务器独立运行并暴露自己的 OpenAPI 模式。您的代理配置可以指向多个工具服务器，从而允许您根据需要进行混合和匹配。

没有限制——只需确保每个服务器运行在自己的端口或地址上，并且代理主机可以访问到它。

🧪 问：在将工具服务器链接到 LLM 代理之前如何测试它？​

答： 您可以使用以下方式测试您的 OpenAPI 工具服务器

  • Swagger UI 或 ReDoc（FastAPI 默认内置）
  • Postman 或 Insomnia
  • 命令行中的 curl 或 httpie
  • Python 的 requests 模块
  • OpenAPI 验证器和模拟器

验证后，您可以将工具服务器注册到 LLM 代理或通过 Open WebUI。

🛠️ 问：我可以扩展或自定义参考服务器吗？​

答： 是的！`servers/` 目录中的所有服务器都设计为简单的模板。您可以 Fork 并修改它们以

  • 添加新的端点和业务逻辑
  • 集成身份验证
  • 更改响应格式
  • 连接到新的服务或内部 API
  • 通过 Docker、Kubernetes 或任何云主机部署

🌍 问：我可以在 AWS 或 GCP 等云平台上运行 OpenAPI 工具服务器吗？​

答： 是的。这些服务器是纯 HTTP 服务。您可以将它们部署为

  • AWS Lambda 与 API Gateway (无服务器)
  • EC2 或 GCP Compute Engine 实例
  • GKE/EKS/AKS 中的 Kubernetes 服务
  • Cloud Run 或 App Engine
  • Render, Railway, Heroku 等。

只需确保它们已安全配置，并在代理或用户需要时可公开访问（或通过 VPN 访问）。

🧪 问：如果我有一个现有的 MCP 服务器怎么办？​

答： 好消息！您可以使用我们的 MCP-to-OpenAPI 网桥：mcpo，将您现有的基于 MCP 的工具暴露为 OpenAPI 兼容的 API 变得前所未有的简单。无需重写，无需头疼——即插即用！🚀

如果您已经使用 MCP 协议构建了工具，`mcpo` 可以帮助您立即解锁与 Open WebUI 和任何基于 OpenAPI 的代理的兼容性——确保您的辛勤工作保持完全可访问性并面向未来。

查看文档中可选的“MCP 网桥”部分以获取设置说明。

快速开始

uvx mcpo --port 8000 -- uvx mcp-server-time --local-timezone=America/New_York

✨ 就这样——您的 MCP 服务器现在已支持 OpenAPI！

🗂️ 问：一个 OpenAPI 服务器可以实现多个工具吗？​

答： 是的。单个 OpenAPI 服务器可以提供在不同端点下分组的多个相关功能。例如，文档服务器可以提供搜索、上传、OCR 和摘要——所有这些都在一个模式中。

如果您倾向于隔离和灵活性，您也可以为每个工具创建一个 OpenAPI 服务器，从而完全模块化。

🙋 还有其他问题吗？访问 GitHub 讨论区以获取社区的帮助和反馈
👉 社区讨论区