Ivo Toby MCP Openapi Server

🚀 OpenAPI MCP 服务器

OpenAPI MCP 服务器是一个基于 Model Context Protocol (MCP) 的服务器，它通过 OpenAPI 端点提供 MCP 资源。该服务器允许大型语言模型借助 MCP 协议，发现并与由 OpenAPI 规范定义的 REST API 进行交互。

🚀 快速开始

您无需克隆此仓库即可使用此 MCP 服务器，只需在 Claude Desktop 中进行如下配置：

1. 找到或创建配置文件：
   • 在 macOS 系统上，配置文件路径为：~/Library/Application Support/Claude/claude_desktop_config.json。
2. 添加配置以启用服务器：

{
  "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_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：运行检查仪，并自动重新加载更改。

代码质量相关

• 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 检查仪 UI 测试您所做的更改。

调试

服务器会将调试日志输出到标准错误流，您可以通过以下方式查看日志：

1. 开发模式下：日志会在运行 inspect-watch 的终端中显示。
2. 直接运行时：

npm run inspect 2>debug.log

📚 详细文档

贡献流程

1. 分叉仓库：在 GitHub 上分叉此仓库。
2. 创建功能分支：基于主分支创建一个新的功能分支。
3. 进行更改：在新分支上进行代码修改。
4. 运行测试和代码检查：

npm run typecheck
npm run lint

5. 提交拉取请求：将修改后的分支提交拉取请求到主仓库。