OpenAPI to MCP Generator

OpenAPI to MCP Generator

site icon
2025.04.14 19
TypeScriptAPI 工具生成开发工具开发效率
OpenAPI to MCP Generator 是一个命令行工具,用于从 OpenAPI 规范生成 Model Context Protocol (MCP) 服务器代码。该工具帮助用户快速创建一个 MCP 服务器,作为大型语言模型 (LLMs) 和 API 之间的桥梁。
View on GitHub

Overview

基本能力

产品定位

OpenAPI to MCP Generator 是一个开发工具,旨在帮助开发者快速将 OpenAPI 规范转换为 MCP 服务器代码,从而简化 LLMs 与 API 的集成过程。

核心功能

  • 自动工具生成:将 OpenAPI 规范中的每个 API 端点转换为 MCP 工具
  • 多种传输选项:支持 stdio、WebSocket 和 HTTP 传输方法
  • 完整项目设置:生成运行 MCP 服务器所需的所有文件
  • TypeScript 支持:包括 TypeScript 定义和配置
  • 简单配置:基于环境的简单配置

适用场景

  • 需要将现有 API 快速集成到 LLMs 中的开发者
  • 希望自动化 API 工具生成的团队
  • 需要支持多种传输协议的 MCP 服务器项目

工具列表

  • openapi-mcp-generator:主命令行工具,用于生成 MCP 服务器代码

使用教程

使用依赖

  • Node.js 16.x 或更高版本
  • npm 7.x 或更高版本

安装教程

# Install globally from npm
npm install -g openapi-mcp-generator

# Or with yarn
yarn global add openapi-mcp-generator

# Or with pnpm
pnpm add -g openapi-mcp-generator

调试方式

生成 MCP 服务器后: 1. 导航到生成的目录: bash cd my-mcp-server 2. 安装依赖: bash npm install 3. 创建环境文件: bash cp .env.example .env 4. 编辑 .env 设置 API 基础 URL 和必要的头信息 5. 启动服务器: bash npm start

常见问题解答

  • 问题:如何指定不同的传输机制? 解答:使用 --transport 选项,可选值为 stdiowebsockethttp
  • 问题:如何从远程 URL 生成 MCP 服务器? 解答:使用 --openapi 选项指定远程 URL,例如 --openapi https://petstore3.swagger.io/api/v3/openapi.json

许可证

该项目遵循 MIT 开源许可条款。