OpenAPI to MCP Server

OpenAPI to MCP Server

site icon
2025.05.05 22
GoAPI转换工具开发工具开发效率
OpenAPI to MCP Server 是一个将 OpenAPI 规范转换为 MCP(Model Context Protocol)服务器配置的工具。它能够将 OpenAPI 的路径转换为 MCP 工具,支持 JSON 和 YAML 格式的 OpenAPI 规范,并生成包含服务器和工具定义的 MCP 配置。该工具保留了参数描述和类型,并根据 OpenAPI 参数位置自动设置参数位置,适用于需要将 REST API 转换为 MCP 配置的开发场景。
View on GitHub

Overview

基本能力

产品定位

OpenAPI to MCP Server 是一个开发工具,旨在帮助开发者将 OpenAPI 规范转换为 MCP 服务器配置,从而简化 REST API 到 MCP 的转换过程。

核心功能

  • 将 OpenAPI 路径转换为 MCP 工具
  • 支持 JSON 和 YAML 格式的 OpenAPI 规范
  • 生成 MCP 配置,包含服务器和工具定义
  • 保留参数描述和类型
  • 自动设置参数位置(路径、查询、头部、Cookie 和正文参数)
  • 生成响应模板,包含字段描述和改进的格式化,便于 LLM 理解
  • 可选验证 OpenAPI 规范(默认禁用)
  • 支持基于模板的配置修补

适用场景

  • 需要将 REST API 转换为 MCP 配置的开发项目
  • 使用 Higress REST-to-MCP 配置的场景
  • 需要自动化生成 MCP 工具配置的开发流程

工具列表

  • openapi-to-mcp: 主工具,用于将 OpenAPI 规范转换为 MCP 配置。

常见问题解答

  • 如何验证 OpenAPI 规范?使用 --validate 标志启用验证。
  • 如何自定义生成的配置?使用 --template 标志提供模板文件进行修补。

使用教程

使用依赖

  • 需要安装 Go 环境。

安装教程

go install github.com/noteworthyten/openapi-to-mcpserver/cmd/openapi-to-mcp@latest

使用教程

openapi-to-mcp --input path/to/openapi.json --output path/to/mcp-server.yaml

调试方式

  • 检查生成的 mcp-server.yaml 文件是否符合预期。
  • 使用 Higress 网关配置验证转换后的 MCP 配置。

许可证

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