🤖 OpenAPI MCP Server

🤖 OpenAPI MCP Server

site icon
2025.04.22 1
TypeScriptAPI 转换AI 代理集成开发效率
OpenAPI MCP Server 是一个命令行工具,能够将任何 OpenAPI 服务转换为符合 Model Context Protocol (MCP) 规范的服务器,从而使得支持 MCP 规范的 AI 代理和工具能够无缝集成和使用这些服务。该工具通过解析 OpenAPI 规范文件,自动生成 MCP 兼容的服务器,并作为中间件代理请求到实际的 OpenAPI 服务,实现 MCP 和 REST 之间的转换。
View on GitHub

Overview

基本能力

产品定位

OpenAPI MCP Server 是一个中间件工具,旨在桥接 OpenAPI 服务和 MCP 客户端,使得现有的 REST API 能够无需修改即可被支持 MCP 的 AI 代理访问和使用。

核心功能

  1. OpenAPI 转换:将 OpenAPI 规范文件转换为 MCP 兼容的服务器。
  2. 请求代理:代理来自 MCP 客户端的请求到实际的 OpenAPI 服务。
  3. 协议转换:在 MCP 和 REST 之间进行协议转换。
  4. 无缝集成:使得 AI 代理能够直接使用现有的 REST API。

适用场景

  1. AI 代理集成:为 AI 代理提供对现有 REST API 的访问能力。
  2. 开发工具链:在开发工具链中集成 MCP 兼容的服务,如 VS Code 的 Copilot 代理模式。
  3. API 测试:使用 MCP Inspector 工具测试和调试 MCP 服务器。

工具列表

  1. MCP Inspector:用于测试和调试 MCP 服务器,提供详细的请求和响应信息。
  2. VS Code Copilot:通过 VS Code 的代理模式与 MCP 服务器交互。

常见问题解答

  1. 如何测试 MCP 服务器?
  2. 使用 MCP Inspector 工具或 VS Code 的 Copilot 代理模式进行测试。
  3. 如何启动 MCP 服务器?
  4. 使用 npx openapi-mcp-proxy 命令并指定 OpenAPI 规范文件和目标 API URL。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。

安装教程

  1. 全局安装 openapi-mcp-proxy: sh npm install -g openapi-mcp-proxy
  2. 启动 MCP 服务器: sh npx openapi-mcp-proxy --spec ./path/to/openapi.yml --target http://your-api.com --port 3000

调试方式

  1. 使用 MCP Inspector: sh npx @modelcontextprotocol/inspector 然后访问 http://localhost:3000/mcp 进行调试。
  2. 使用 VS Code Copilot:
  3. 启用代理模式并添加 MCP 服务器 URL(如 http://localhost:3000/mcp)。
  4. 通过聊天界面与 MCP 服务器交互。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。