产品简介
openapi-to-mcpserver 一款面向开发者的命令行工具,可将OpenAPI(Swagger)规范文件自动转换为Higress网关所需的MCP(模型上下文协议)服务器配置YAML。解决手动编写配置繁琐易错的问题,适合需要将现有API快速集成到AI应用中的开发者。
核心功能
- 自动将OpenAPI规范转换为MCP配置
- 支持JSON或YAML格式的OpenAPI输入文件
- 可自定义服务器名称及工具名称前缀
- 自动识别参数位置(路径/查询/请求体)并设置position字段
- 生成包含详细字段说明的YAML配置文件
快速开始
- 第一步:通过 `go install github.com/higress-group/openapi-to-mcpserver/cmd/openapi-to-mcp@latest` 安装工具。
- 第二步:准备好符合OpenAPI规范的JSON或YAML文件(如 `petstore.json`)。
- 第三步:运行命令 `openapi-to-mcp --input your-api.json --output config.yaml --server-name your-server` 进行转换。
- 第四步:将生成的YAML配置文件添加到你的Higress网关配置中即可使用。
界面预览
与其他方案对比
| 对比项 | openapi-to-mcpserver | 同类方案 |
|---|---|---|
| 配置生成方式 | 自动化转换,基于OpenAPI规范一键生成,准确高效。 | 手动编写或参考文档逐条编写,易出错、耗时长。 |
| 配置优化 | 专为Higress REST-to-MCP场景设计,自动生成包含`position`等关键字段的配置。 | 通用代码生成工具可能无法针对此特定协议进行优化。 |
适合谁用
- 需要将现有RESTful API快速集成到Higress网关并用于AI应用(如大模型调用)的后端开发者
- 维护OpenAPI规范文档,并希望自动化生成网关配置的开发团队
- 希望为Higress网关添加基于MCP协议的AI能力的运维或架构人员
下载与版本
当前最新版本为 v1.0.0,发布于 2025-11-05。支持 Windows、macOS、Linux。
⚠️ 注意:本项目仅提供源代码下载,不包含可直接运行的安装包(exe/dmg/apk 等。下载后需要自行编译构建才能使用,适合有一定开发经验的用户。如果你不熟悉编译流程,建议寻找同类开箱即用的替代方案。
注意事项
- 本工具仅供学习和研究使用,请遵守相关法律法规。
- 请尊重内容创作者版权,勿将下载内容用于商业或非法传播。
- 项目源码地址:https://github.com/higress-group/openapi-to-mcpserver