
OpenAPI to MCP server Generator

2025.04.24
1
JavaScriptAPI 集成代码生成开发效率
OpenAPI to MCP server Generator 是一个命令行工具,用于从 OpenAPI 规范生成 Model Context Protocol (MCP) 服务器代码。该工具帮助用户快速创建一个 MCP 服务器,作为大型语言模型 (LLMs) 和 API 之间的桥梁。
View on GitHub
Overview
基本能力
产品定位
OpenAPI to MCP server Generator 是一个开发工具,旨在帮助开发者快速生成 MCP 服务器代码,以便将 OpenAPI 规范的 API 与大型语言模型 (LLMs) 集成。
核心功能
- 自动工具生成:将 OpenAPI 规范中的每个 API 端点转换为 MCP 工具。
- 传输选项:支持 stdio 传输机制,对于 SSE 可以通过 mcp-proxy 实现。
- 完整项目设置:生成运行 MCP 服务器所需的所有文件。
- 简单配置:基于环境变量的简单配置。
适用场景
- 需要将现有 API 与 LLMs 集成的场景。
- 快速生成 MCP 服务器代码的开发场景。
- 需要自动化工具生成的开发流程。
工具列表
- server.js:主 MCP 服务器实现。
- package.json:依赖和脚本。
- README.md:生成的服务器文档。
- .env.example:环境变量模板。
- types.d.ts:TypeScript 类型定义。
- tsconfig.json:TypeScript 配置。
常见问题解答
- 安全方案支持:支持 apiKey 和 http 安全方案,oauth2 和 openIdConnect 支持有限。
- 错误处理:遇到错误时,会将消息发送到 stderr。
使用教程
使用依赖
- Node.js 16.x 或更高版本。
- npm 7.x 或更高版本。
安装教程
# 使用 npm 全局安装
npm install -g openapi-mcpserver-generator
# 使用 yarn 全局安装
yarn global add openapi-mcpserver-generator
# 使用 pnpm 全局安装
pnpm add -g openapi-mcpserver-generator
调试方式
- 生成 MCP 服务器:
openapi-mcpserver-generator --openapi path/to/openapi.json --output /Path/to/output
- 进入生成的目录:
cd my-mcp-server
- 安装依赖:
npm install
- 创建环境文件:
cp .env.example .env
- 编辑
.env
文件设置 API 基础 URL 和必要的头信息。 - 启动服务器:
npm start