OpenAPI MCP Server

OpenAPI MCP Server

镜像

简介

OpenAPI MCP 服务器是一个工具,它将任何符合 OpenAPI (v3.1) 规范的 API 转换为 Model Context Protocol (MCP) 服务器,使您能够通过 Claude 桌面应用与这些 API 进行自然语言交互。

功能亮点

  • 自动将 OpenAPI 端点转换为 Claude 工具
  • 支持文件上传(multipart/form-data)
  • Claude 可以发现 API 端点并理解其用途、参数和响应

快速设置

  1. 安装工具

    npm install -g openapi-mcp-server
    
  2. 配置 Claude 桌面: 在 claude_desktop_config.json 中添加以下内容:

    {
      "mcpServers": {
        "your-api-name": {
          "command": "npx",
          "args": ["openapi-mcp-server", "/path/to/your-openapi.json"]
        }
      }
    }
    
  3. 重启 Claude 桌面应用

  4. 开始使用:通过自然语言与 Claude 交流,让它帮您调用 API

使用示例

如果您有一个包含以下端点的 Petstore API:

/pets/{petId}:
  get:
    operationId: getPetById
    summary: 根据 ID 返回宠物信息
    parameters:
      - name: petId
        in: path
        description: 要返回的宠物的 ID
        required: true
        schema:
          type: integer

您可以向 Claude 提问:

  • "你能获取 ID 为 123 的宠物的详细信息吗?"
  • "我的 ID 为 456 的宠物的状态是什么?"

文件上传示例

对于支持文件上传的 API 端点(type: string, format: binary),您可以这样使用:

"从 ~/Pictures/profile.jpg 上传我的新头像"
"处理位于 ~/Documents/contract.pdf 的英文文档并启用 OCR"

故障排除

如果遇到 Claude 崩溃或规格无法工作的问题,请通过规范清理应用程序处理您的 OpenAPI 规范。

限制

  • 仅支持 OpenAPI v3.1 规范
  • 响应处理针对 JSON/文本优化
  • 仅支持本地文件上传(不支持远程 URL)
  • 暂不支持流式响应

更多信息

查看项目仓库获取完整文档和示例。