Openapi MCP Proxy

🚀 OpenAPI MCP 服务器

一个命令行工具，能把任意 OpenAPI 服务转换为 Model Context Protocol (MCP) 服务器，实现与 AI 代理及支持 MCP 规范工具的无缝集成。

🚀 快速开始

OpenAPI MCP 服务器是一款强大的命令行工具，可助力您轻松将 OpenAPI 服务转化为 MCP 服务器。以下是快速上手的步骤：

安装

npm install -g openapi-mcp-proxy

基本使用

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

✨ 主要特性

• 协议转换：可将 OpenAPI 服务转换为符合 MCP 标准的服务器，实现与 AI 代理和支持 MCP 规范的工具无缝集成。
• 自动生成：接受 OpenAPI 规范文件作为输入，自动生成符合 MCP 标准的服务器。
• 请求代理：代理到实际 OpenAPI 服务的请求，并在 MCP 和 REST 约定之间进行转换。

📚 详细文档

什么是 Model Context Protocol (MCP)?

Model Context Protocol (MCP) 是一种标准化协议，用于 AI 代理与外部工具和服务之间的交互。它提供了一种统一的方式来发现、理解和利用各种能力，使构建能够与多种服务交互的 AI 驱动应用程序变得更加简单。

什么是 OpenAPI?

OpenAPI（以前称为 Swagger）是描述机器可读接口文件的标准，用于定义、生成、消费和可视化 RESTful 网络服务。它允许人类和计算机无需访问源代码或额外文档即可发现和理解服务的功能。

关于该项目

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

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

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

🔧 技术细节

该项目主要实现了 OpenAPI 服务与 MCP 客户端之间的交互，通过一系列步骤将 OpenAPI 服务转换为 MCP 服务器：

1. 读取 OpenAPI 规范文件，解析其中的接口信息。
2. 根据 MCP 标准生成对应的服务器代码。
3. 当接收到 MCP 客户端的请求时，将其转换为符合 REST 约定的请求，并代理到实际的 OpenAPI 服务。
4. 将 OpenAPI 服务的响应转换为 MCP 格式，返回给 MCP 客户端。

📦 安装指南

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

npm install -g openapi-mcp-proxy

💻 使用示例

基础用法

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

高级用法

MCP 检查工具

要测试您的 MCP 服务器，请执行以下操作：

1. 安装检查工具：npm install -g @merossai/mcpx
2. 启动检查工具：mcpx <your_api_key> http://localhost:3000

VS Code 中的配置

在 VS Code 中，您可以按 Ctrl+Shift+P 打开命令面板：

1. 输入并选择 "Remote-Containers: Start Server"
2. 配置代理设置：
   • 代理 URL: http://localhost:3000
   • 直接连接到目标端口: true

🤝 贡献

欢迎为该项目做出贡献！如果有任何问题或建议，请提交 问题 或 拉取请求。

📄 许可证

此项目受 MIT 许可证的保护。

⚠️ 重要提示

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