OpenAPI to MCP Server

OpenAPI to MCP Server

site icon
2025.04.23 0
GoAPI转换工具开发工具开发效率
OpenAPI to MCP Server 是一个将OpenAPI规范转换为MCP(Model Context Protocol)服务器配置的工具。它能够将OpenAPI的路径、参数和响应结构转换为MCP工具定义,并生成相应的YAML或JSON配置文件。该工具支持参数描述和类型的保留,自动设置参数位置,并生成易于LLM理解的响应模板。
View on GitHub

Overview

基本能力

产品定位

OpenAPI to MCP Server 是一个转换工具,旨在将OpenAPI规范转换为MCP服务器配置,以便在MCP环境中使用。

核心功能

  • 将OpenAPI路径转换为MCP工具
  • 支持JSON和YAML格式的OpenAPI规范
  • 生成包含服务器和工具定义的MCP配置
  • 保留参数描述和类型
  • 自动根据OpenAPI参数位置设置参数位置
  • 处理路径、查询、头部、cookie和主体参数
  • 生成带有字段描述和改进格式的响应模板
  • 可选验证OpenAPI规范
  • 支持基于模板的配置修补

适用场景

  • 将现有的OpenAPI规范快速转换为MCP配置
  • 在MCP环境中集成RESTful API
  • 自动化API配置生成

工具列表

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

常见问题解答

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

使用教程

使用依赖

  • 需要安装Go语言环境

安装教程

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

使用教程

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

调试方式

  • 确保输入文件路径正确
  • 检查输出文件是否生成
  • 使用--validate标志验证OpenAPI规范

示例

openapi-to-mcp --input petstore.json --output petstore-mcp.yaml --server-name petstore

许可证

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