OpenAPI MCP 服务器

概述

• 此项目将安装 MCP - Model Context Protocol Server，该服务器提供配置好的 REST API 作为 LLM 的上下文。
• 使用此服务器，我们可以启用 LLM 与 REST API 的交互，并通过 LLM 提示执行 REST API 调用。
• 当前支持的 HTTP 请求方法为 GET/PUT/POST/PATCH。

安装

• 安装包：

  pip install openapi_mcp_server
  

• 在文件夹中创建 .env 文件，设置必要的值以配置 OPENAPI_SPEC_PATH 和 API_BASE_URL。示例文件可在此处下载 这里。
• 使用以下命令测试 openapi_mcp_server 服务器：

  uv run openapi_mcp_server
  

Claud 桌面配置

• 配置示例：

  {
    "mcpServers": {
      "openapi_mcp_server":{
        "command": "uv",
        "args": ["run","openapi_mcp_server"]
        "env": {
            "DEBUG":"1",
            "API_BASE_URL":"https://petstore.swagger.io/v2",
            "OPENAPI_SPEC_PATH":"https://petstore.swagger.io/v2/swagger.json",
            "API_HEADERS":"Accept:application/json",
            "API_WHITE_LIST":"addPet,updatePet,findPetsByStatus"
        }
      }
    }
  }
  

  

配置

• 可用的环境变量列表：
  • DEBUG：启用调试日志记录（可选，默认为 False）
  • OPENAPI_SPEC_PATH：OpenAPI 文档路径（必需）
  • API_BASE_URL：API 请求的基础 URL（必需）
  • API_HEADERS：包含在 API 请求中的头信息（可选）
  • API_WHITE_LIST：白名单操作 ID 列表（格式为 ["operationId1", "operationId2"]，可选）
  • API_BLACK_LIST：黑名单操作 ID 列表（格式为 ["operationId3", "operationId4"]，可选）
  • HTTP_PROXY：HTTP 代理信息（可选）
  • HTTPS_PROXY：HTTPS 代理信息（可选）
  • NO_PROXY：无代理信息（可选）

贡献

欢迎贡献。
请随意提交 Pull Request。

许可证

本项目根据 MIT 许可证的条款进行许可。

GitHub 星级

附录

UV

mkdir -m777 openapi_mcp_server
cd openapi_mcp_server
uv init
uv add mcp 协议 协议、协议、协议
uv sync
uv run
uv build

• uv init：初始化项目。
• uv add [依赖项...]：添加所需的依赖项。例如，运行 uv add openapi-spec 协议 可能会自动添加 OpenAPI 相关的依赖项。
• uv sync：同步代码。
• uv run：运行服务器。
• uv build：构建项目。

这些命令帮助开发者快速初始化、配置和部署 MCP 服务器，确保所有依赖项已正确安装，并且代码处于最新状态。通过这种方式，用户可以轻松地将服务器集成到现有的开发环境中，并进行进一步的自定义和扩展。

反馈与支持

如果在使用过程中遇到任何问题或需要进一步的支持，请随时查阅项目文档或联系维护人员。您的反馈对我们改进项目非常宝贵！