OpenAPI MCP 服务器

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

快速开始

您无需克隆此存储库即可使用此 MCP 服务器。您可以直接在 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"
      }
    }
  }
}

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

开发工具

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

构建

• npm run build - 构建 TypeScript 源代码
• npm run clean - 移除构建产物
• npm run typecheck - 运行 TypeScript 类型检查

开发模式

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

代码质量

• 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 测试您的更改

调试

服务器将调试日志输出到 stderr。要查看这些日志：

1. 在开发模式下：

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

2. 直接运行时：

   npm run inspect 2>debug.log
   

贡献

1. Fork 存储库
2. 创建一个特性分支
3. 进行更改
4. 运行测试和 linting：

   npm run typecheck
   npm run lint
   

5. 提交一个 pull request

许可证

MIT