MCP-OpenAPI

一个 模型上下文协议 (Model Context Protocol) 服务器，它将 OpenAPI 规范中的 HTTP 方法作为工具公开。

[!WARNING] 这是一个概念验证，尚未经过全面测试和记录。

用法

每个 MCP-OpenAPI 服务器公开来自单个 OpenAPI 规范的操作。您可以运行多个实例来公开多个规范。

此软件包可在 PyPI 上找到 @ [mcp-openapi][pypi]。您可以使用 uvx mcp-openapi --openapi-url https://httpbin.org/spec.json (sse | stdio) 启动服务器。

一个 Claude 配置示例（在运行 fastapi dev tests/todos.py 且端口为 8000 时）：

{
  "mcpServers": {
    "todos": {
    "command": "uvx",
    "args": [
        "mcp-openapi",
        "--openapi-url=http://localhost:8000/openapi.json",
        "stdio"
      ]
    }
  }
}

OpenAPI URL 也可以作为环境变量 MCP_OPENAPI_URL 传递。

以 SSE 模式运行时，您可以使用以下选项配置服务器：

• --fastmcp-sse-host - 用于提供 MCP 服务器的主机
• --fastmcp-sse-port - 用于提供 MCP 服务器的端口

还有其他全局选项：

• --fastmcp-debug - 启用 MCP 服务器的调试模式
• --fastmcp-log-level - MCP 服务器的日志级别

这些也可以通过使用 FASTMCP_ 前缀的环境变量进行配置，例如 FASTMCP_LOG_LEVEL=DEBUG。

工作原理

1. MCP-OpenAPI 服务器使用 OpenAPI 规范 URL 进行初始化。
2. 服务器获取并解析 OpenAPI 规范，并将每个路径操作注册为一个工具。
3. 启动一个带有已注册工具的 FastMCP 服务器。
4. 当客户端请求一个工具时，MCP 服务器向 API 发出 HTTP 请求并返回响应。

支持的 OpenAPI/Swagger 版本

Swagger 2.0	OpenAPI 3.0	OpenAPI 3.1
:x:	:heavy_check_mark:	:heavy_check_mark:

此软件包支持 JSON 和 YAML 格式的 OpenAPI 3.0 和 3.1 规范。

我们在底层使用了 openapi-parser，它似乎非常全面，并且支持解析对外部规范的引用。

未来的配置选项

[!INFO] 这些尚未实现。

限制端点

默认情况下，所有端点都作为工具公开。您可以限制公开哪些端点：

• 按路径模式，
• 按 HTTP 方法，
• 显式列出要公开的各个操作，
• 使用 OpenAPI 标签选择路由。

处理 API 身份验证

MCP-OpenAPI 向目标 API 发出 API 请求 - 它可以使用全局身份验证令牌：

• --auth-token - 一个 bearer 令牌，或 base64 格式的基本凭据，具体取决于 OpenAPI 规范。

如果能够使用不同的身份验证令牌（例如，每个客户端用户）发出请求，而无需让 LLM 看到令牌，那就太好了。待定。