OpenAPI → MCP Server

OpenAPI → MCP 服务

独立的 CLI，可根据 OpenAPI 规范诊断、比较差异、生成、运行和测试 Node.js/TypeScript MCP 服务。

安装

从 PyPI 安装 openapi-to-mcp-cli。需要 Python 3.14+； 构建和运行生成的服务还需要 Node.js 22+ 和 npm。

uv tool install openapi-to-mcp-cli
openapi-to-mcp --help

安装后的命令仍为 openapi-to-mcp。如需临时使用：

uvx --from openapi-to-mcp-cli openapi-to-mcp --help

有关升级、带标签的 Git 安装和发行版构件，请参阅安装指南。

快速入门

生成可重复使用的项目：

openapi-to-mcp generate \
  --openapi-json ./openapi.yaml \
  --output-dir ./generated-server

直接根据规范运行：

openapi-to-mcp run \
  --openapi-json https://petstore3.swagger.io/api/v3/openapi.json \
  --target-api-base-url https://petstore3.swagger.io/api/v3

对正在运行的服务执行冒烟测试：

openapi-to-mcp test-server \
  --transport streamable-http \
  --host 127.0.0.1 \
  --port 8080 \
  --mcp-endpoint /mcp \
  --list-tools

文档

公开产品文档托管在 GitHub Pages 上：

• 文档主页：nihal1294.github.io/openapi-to-mcp

当前功能

• stdio 和 streamable-http 生成目标
• 使用 doctor 诊断规范就绪情况
• 使用 diff 比较 MCP 接口
• 使用 mcpgen.yaml 配置可重复的生成策略
• 通过 src/custom/tools.ts 添加可在重新生成时保留的自定义工具
• 根据规范元数据生成更丰富的工具描述和输入示例
• 可选的工具名称分组，并添加首个标签前缀
• 可选的请求级工具允许列表，供 streamable-http 调用方使用
• 可选的请求和响应负载脱敏审计日志
• 可选的安全上游调用重试预算和熔断器
• 基于明确的运行时控制构建、可供审核的性能预设
• 默认启用严格模式，并生成 generation_report.json
• 为 apiKey、bearer、OAuth2 和 OpenID Connect 生成身份验证环境变量映射
• 生成并发、排队、超时、有界缓存、限流、重试和熔断器等运行时控制项
• 针对本地模拟 API 的生成服务端到端测试覆盖
• 对 generate、run 和 test-server 进行 CLI 端到端测试覆盖
• 在 master 上自动执行带版本管理的 PyPI 和 GitHub Releases 发布流程

Swagger 2 支持

支持仅包含响应的 Swagger 2 操作和基础 URL 字段。生成前，请将使用 Swagger 2 请求体或表单参数、顶层参数类型、安全定义或不受支持的协议覆盖项的操作转换为 OpenAPI 3。运行 openapi-to-mcp doctor 可找出受影响的操作和字段。

开发

有关仓库本地工作流，请直接参阅仓库文档：

• 源码和本地工作流：本地工作流
• 贡献指南：贡献指南

许可证

Apache License 2.0。请参阅 LICENSE。