OpenAPI MCP Server

OpenAPI MCP Server

镜像

这是一个模型上下文协议(MCP)服务器,将OpenAPI端点作为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认证头部(逗号分隔的键值对)

高级配置选项

环境变量

  • SERVER_NAME: MCP服务器名称(默认:"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 \
  --headers "Authorization:Bearer token123,X-API-Key:your-api-key" \
  --name "my-mcp-server" \
  --version "1.0.0"

开发工具

  • 构建:npm run build
  • 开发模式:npm run dev
  • 检查器模式:npm run inspect-watch
  • 代码检查:npm run lintnpm run typecheck

调试

服务器在开发模式下将日志输出到控制台,也可通过重定向查看:

npm run inspect 2>debug.log

许可证

MIT