OpenAPI MCP 服务器

一个通过 OpenAPI 端点暴露为 MCP 资源的模型上下文协议 (MCP) 服务器。此服务器允许大型语言模型通过 MCP 协议发现并交互由 OpenAPI 规范定义的 REST API。

快速开始

您无需克隆此仓库即可使用此 MCP 服务器。您只需在 Claude 桌面中配置它：

1. 找到或创建您的 Claude 桌面配置文件：

   • 在 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"
      }
    }
  }
}

3. 将环境变量替换为您的实际 API 配置：
   • API_BASE_URL：API 的基础 URL
   • OPENAPI_SPEC_PATH：OpenAPI 规范的 URL 或路径
   • API_HEADERS：用于 API 身份验证的逗号分隔键值对

开发工具

此项目包含几种开发工具，以简化您的工作流程：

构建

• npm run build - 编译 TypeScript 源代码
• npm run clean - 删除构建 artifacts
• npm run typecheck - 运行 TypeScript 类型检查

开发模式

• npm run dev - 监视源文件并在更改时重建
• npm run inspect-watch - 运行 inspector 并在更改时自动重新加载

代码质量

• npm run lint - 运行 ESLint
• npm run typecheck - 验证 TypeScript 类型

配置

服务器可通过环境变量或命令行参数进行配置：

环境变量

• 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"

开发工作流程

1. 启动开发环境：

npm run inspect-watch

2. 对 src/ 中的 TypeScript 文件进行更改
3. 服务器会自动重建并重新启动
4. 使用 MCP Inspector UI 测试您的更改

调试

服务器将调试日志输出到标准错误流。要查看这些日志：

1. 在开发模式下：

   • 日志在运行 inspect-watch 的终端中显示

2. 当直接运行时：

   npm run inspect 2>debug.log
   

贡献

1. Fork 仓库
2. 创建功能分支
3. 进行您的更改
4. 运行测试和 linting：

   npm run typecheck
   npm run lint
   

5. 提交拉取请求

许可证

MIT