Openapi Proxy

🚀 OpenAPI MCP 服务器

一个命令行工具，可将任意 OpenAPI 服务转换为 Model Context Protocol (MCP) 服务器，实现与 AI 代理和支持 MCP 规范的工具之间的无缝集成，让服务使用更便捷。

⚠️ 重要提示

此工具仍处于早期开发阶段。开发路线图在此

🚀 快速开始

本工具可将任意 OpenAPI 服务转换为 MCP 服务器，实现与 AI 代理和支持 MCP 规范的工具无缝集成。下面为你介绍详细的安装和使用方法。

✨ 主要特性

• 接收 OpenAPI 规范文件作为输入，自动生成符合 MCP 标准的服务器。
• 代理到实际 OpenAPI 服务的传入请求，在 MCP 和 REST 约定之间进行转换。
• 让任何具有 OpenAPI 规范的现有 REST API 能立即对理解 MCP 的 AI 代理可用，无需修改原始服务。

📦 安装指南

使用以下命令进行全局安装：

npm install -g openapi-mcp-proxy

💻 使用示例

基础用法

使用以下命令启动 MCP 服务器：

npx openapi-mcp-proxy --spec ./path/to/openapi.yml --target http://your-api.com --port 3000

选项说明

• -s, --spec <路径>（必需）：OpenAPI 规范文件的路径（环境变量：OMP_OPENAPI_SPEC_FILE）
• -t, --target <URL>（可选）：目标 API 服务 URL（默认：http://localhost:8080，环境变量：OMP_TARGET_BASE_URL）
• -p, --port <数字>（可选）：运行 MCP 服务器的端口（默认：3000，环境变量：PORT）
• -V, --version：显示版本号
• -h, --help：显示帮助信息

示例

启动 Petstore API 的 MCP 服务器：

npx openapi-mcp-proxy --spec resources/petstore.openapi.yml --target https://petstore.swagger.io/v2

📚 详细文档

什么是 Model Context Protocol (MCP)?

模型上下文协议（MCP）是 AI 代理与外部工具和服务交互的标准协议。它为 AI 模型提供了一种统一的方式来发现、理解并利用各种功能，从而简化了构建支持多个服务的 AI 驱动应用程序的过程。

什么是 OpenAPI?

OpenAPI（原名为 Swagger）是一项机器可读接口文件规范，用于描述、生成、消费和可视化 RESTful 网络服务。它使人类和计算机能够无需访问源代码或额外文档即可发现和理解服务的功能。

关于该项目

此中间件作为 OpenAPI 服务与 MCP 客户端之间的桥梁：

1. 接收 OpenAPI 规范文件作为输入
2. 自动生成符合 MCP 标准的服务器
3. 代理到实际 OpenAPI 服务的传入请求
4. 在 MCP 和 REST 约定之间进行转换

这使得任何具有 OpenAPI 规范的现有 REST API 能立即对理解 MCP 的 AI 代理可用，而无需修改原始服务。

测试

MCP 检查器

要测试你的 MCP 服务器，可以使用 Model Context Protocol Inspector：

1. 安装 MCP 检查器：

npx @modelcontextprotocol/inspector

2. 启动你的 MCP 服务器
3. 打开检查器的界面并输入正确的服务器路径（以 /mcp 结尾），例如 http://localhost:3000/mcp
4. 现在你可以通过 MCP 检查器与你的 MCP 服务器交互。检查器会显示请求和响应的详细信息。

VS Code 使用方法

1. 打开 VS Code 并安装 MCP 代理 插件。
2. 启动 MCP 服务器后，通过以下步骤配置代理：
   • 点击右下角的代理图标
   • 选择 "Add Proxy"
   • 填写代理名称和地址（例如 http://localhost:3000）
3. 在你的项目中设置代理配置文件（如 .mcp-proxy.json）：

{
  "proxies": {
    "my-api": {
      "target": "https://petstore.swagger.io/v2",
      "proxyUrl": "http://localhost:3000"
    }
  }
}

📄 许可证

该项目遵循 MIT 许可证。更多信息请参见 LICENSE 文件。