OpenAPI MCP Server

OpenAPI MCP Server

将OpenAPI规范转换为MCP资源的MCP Server。

GitHub
Created Byivo-tobyivo-toby

OpenAPI MCP 服务器能将 OpenAPI 端点作为 MCP 资源公开，让大型语言模型通过 MCP 协议发现并与 REST API 交互。

设置步骤

无需克隆仓库，只需在 Claude Desktop 中配置：

  1. 找到/创建 Claude Desktop 配置文件：

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  2. 添加 OpenAPI MCP 服务器配置：

{
  "mcpServers": {
    "openapi": {
      "command": "npx",
      "args": ["-y", "@ivotoby/openapi-mcp-server"],
      "env": {
        "API_BASE_URL": "https://api.example.com",
        "OPENAPI_SPEC_PATH": "https://api.example.com/openapi.json",
        "API_HEADERS": "Authorization:Bearer token123,X-API-Key:your-api-key"
      }
    }
  }
}
  1. 替换环境变量为您的 API 配置：
    • API_BASE_URL: API 基础 URL
    • OPENAPI_SPEC_PATH: OpenAPI 规范 URL/路径
    • API_HEADERS: API 认证头部 (逗号分隔的键值对)

配置选项

环境变量

  • API_BASE_URL - API 基础 URL
  • OPENAPI_SPEC_PATH - OpenAPI 规范路径
  • API_HEADERS - API 头部 (格式: key1:value1,key2:value2)
  • SERVER_NAME - 服务器名称 (默认: "mcp-openapi-server")
  • SERVER_VERSION - 版本 (默认: "1.0.0")

命令行参数

npm run inspect -- --api-base-url https://api.example.com --openapi-spec https://api.example.com/openapi.json

开发

常用命令

  • npm run build - 构建源代码
  • npm run dev - 监视并自动重构
  • npm run inspect-watch - 自动重载检查器
  • npm run lint - 运行 ESLint
  • npm run typecheck - 验证类型

调试

服务器日志输出到 stderr：

npm run inspect 2>debug.log

许可证

MIT