OpenAPI转MCP工具

一个将OpenAPI 3.x规范转换为FastMCP服务器代码的工具,适用于需要快速生成MCP服务器代码的开发场景。

  • by VitalyMalakanov
  • Python
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 VitalyMalakanov/openapi2mcp

使用说明

OpenAPI2MCP

一个将OpenAPI 3.x规范转换为FastMCP服务器的工具。

安装

poetry install

用法/命令

openapi2mcp 提供了一个命令行界面,用于根据OpenAPI规范生成和管理MCP服务器代码。

generate

从OpenAPI规范文件生成MCP服务器Python代码。

语法:

openapi2mcp generate [OPTIONS]

选项:

  • -i, --input-file PATH:OpenAPI规范文件(JSON或YAML)的路径。(必填)
  • -o, --output-file PATH:生成的MCP服务器的输出Python文件的路径。(必填)
  • -t, --transport [stdio|google_pubsub]:MCP服务器的传输机制。(默认值: stdio)
  • --llms-txt-file PATH:生成可选路径 llms.txt 该文件提供了为语言模型生成的工具和资源的描述。如果没有指定, llms.txt 将在与输出服务器文件相同的目录中创建。
  • --mount TEXT:资源的可选装载路径(例如。, /myapi/v1).(默认值: "")

例子:

openapi2mcp generate --input-file examples/example_openapi.yaml --output-file generated_server.py --transport stdio --mount "/api"

此命令将解析 examples/example_openapi.yaml,生成名为的MCP服务器文件 generated_server.py 使用 stdio 传输,并将资源装载路径设置为 /api。它还将生成 llms.txt 文件与位于同一目录中 generated_server.py.

check

检查生成的MCP服务器Python文件的基本代码有效性,包括语法和关键MCP模式的存在。

语法:

openapi2mcp check --server-file PATH

选项:

  • --server-file PATH:要检查的生成的MCP服务器Python文件的路径。(必填)

例子:

openapi2mcp check --server-file generated_server.py

version

显示的版本 openapi2mcp 工具。

语法:

openapi2mcp version

例子:

openapi2mcp version

例子

请参阅示例实现:

项目结构

  • openapi2mcp/parser.py:OpenAPI规范解析器
  • openapi2mcp/generator.py:FastMCP服务器代码生成器
  • openapi2mcp/cli.py:命令行界面

许可证

麻省理工学院-参见 许可证