OpenAPI MCP Server

OpenAPI MCP Server

site icon
2025.03.29 1
TypeScriptAPI 交互OpenAPI 转换开发效率
OpenAPI MCP Server 是一个从 OpenAPI (v3) 规范文件生成 Model Context Protocol (MCP) 服务器的项目。它允许像 Claude 这样的 AI 模型通过 MCP 工具与定义的 API 端点进行交互。该项目由 Cline 和 gemini-2.5-pro 生成,适用于需要将 OpenAPI 规范转换为 MCP 服务器的场景。
View on GitHub

Overview

基本能力

产品定位

OpenAPI MCP Server 旨在将 OpenAPI 规范转换为 MCP 服务器,使 AI 模型能够通过 MCP 工具与 API 端点交互。

核心功能

  • 从 OpenAPI (v3) 规范文件生成 MCP 服务器
  • 支持 JSON 和 YAML 格式的 OpenAPI 规范
  • 可通过命令行运行和调试
  • 可配置为 MCP 客户端(如 Claude VS Code 扩展)的服务器

适用场景

  • 需要将 OpenAPI 规范转换为 MCP 服务器的开发场景
  • AI 模型与 API 端点的交互
  • 快速测试和调试 API 规范

工具列表

  • listPets:列出宠物
  • showPetById:通过 ID 显示宠物

常见问题解答

  • 确保使用绝对路径配置 MCP 客户端
  • 确保 OpenAPI 规范文件路径正确
  • 确保 Bun 运行时已安装

使用教程

使用依赖

安装教程

  1. 克隆或下载项目
  2. 进入项目目录 bash cd openapi-mcp-server
  3. 安装依赖 bash bun install

调试方式

  1. 编译 TypeScript 代码 bash bun build ./src/index.ts --outdir ./dist --target=bun
  2. 运行服务器 bash bun run ./dist/index.js <path-to-openapi-spec> [optional-base-url]
    • <path-to-openapi-spec>:OpenAPI 规范文件的路径(JSON 或 YAML)
    • [optional-base-url]:覆盖 OpenAPI 规范中的 servers[0].url

许可证

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