OpenAPI x MCP

OpenAPI x MCP

site icon
2025.04.16 7
TypeScript开发工具MCP 服务器生成开发效率
OpenAPI x MCP 是一个从 OpenAPI 规范生成类型安全的 MCP(Model Context Protocol)服务器的工具。它通过 CLI 命令提供服务器代码生成、配置管理等功能,适用于需要快速构建和配置 MCP 服务器的开发场景。
View on GitHub

Overview

基本能力

产品定位

OpenAPI x MCP 是一个开发工具,旨在通过 OpenAPI 规范快速生成类型安全的 MCP 服务器代码,简化开发流程。

核心功能

  1. 生成服务器代码:从 OpenAPI 规范生成 MCP 服务器代码。
  2. 配置管理:支持添加、更新和删除 MCP 服务器的客户端配置。
  3. 本地运行:提供本地运行服务器的功能。

适用场景

  1. 需要从 OpenAPI 规范快速生成 MCP 服务器的开发场景。
  2. 需要管理多个客户端配置的开发环境。
  3. 本地开发和测试 MCP 服务器。

工具列表

  1. generate:从 OpenAPI 规范生成 MCP 服务器代码。
  2. config add:添加或更新 MCP 服务器的客户端配置。
  3. config remove:删除 MCP 服务器的客户端配置。
  4. server:运行 MCP 服务器。

常见问题解答

  1. 如何生成服务器代码? bash npx -y -p @usemodel-dev/cli@latest cli generate <ABSOLUTE_PATH_TO_SPEC_YAML_OR_JSON>
  2. 如何添加配置? bash npx -y -p @usemodel-dev/cli@latest cli config add <client> '<config_json>'
  3. 如何删除配置? bash npx -y -p @usemodel-dev/cli@latest cli config remove <client> <servername>

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 安装必要的依赖: bash npm install @modelcontextprotocol/sdk express openapi-typescript zod

安装教程

  1. 生成服务器代码: bash npx -y -p @usemodel-dev/cli@latest cli generate <ABSOLUTE_PATH_TO_SPEC_YAML_OR_JSON>
  2. 构建服务器: bash pnpm build
  3. 运行服务器: bash pnpm start

调试方式

  1. 确保服务器已启动并运行在 http://localhost:3001
  2. 使用客户端工具(如 Cursor、Windsurf 或 Claude)测试服务器配置。
  3. 检查日志文件以获取调试信息。

许可证

该项目遵循 MIT 开源许可条款。