@openapi-mcp/server

@openapi-mcp/server

site icon
2025.04.17 2
TypeScriptAPI 转换AI 集成开发效率
openapi-mcp-server 是一个强大的桥梁,连接 OpenAPI 规范和 AI 助手,使用 Model Context Protocol (MCP)。它自动将任何 OpenAPI/Swagger API 规范转换为 MCP 工具,供 Claude Desktop 等 AI 助手使用。这使得 AI 助手能够无缝地与您的 API 交互,通过您的服务执行实际操作,而无需自定义集成。
View on GitHub

Overview

基本能力

产品定位

openapi-mcp-server 是一个将 OpenAPI/Swagger 规范转换为 MCP 工具的服务,旨在为 AI 助手提供与 API 交互的能力。

核心功能

  • OpenAPI 集成:自动将 OpenAPI/Swagger 规范转换为 MCP 工具
  • 多版本支持:支持 OpenAPI v3.0.0 和 v3.1.0
  • 认证支持
  • HTTP 认证方案(基本认证、Bearer 令牌认证等)
  • API 密钥(基于头部的 API 密钥)

适用场景

  • AI 助手与 API 的交互
  • 快速将现有 API 规范转换为 AI 可用的工具
  • 开发者在 AI 助手中集成自定义 API 功能

工具列表

  • OpenAPI 转换工具:将 OpenAPI 规范转换为 MCP 工具
  • 认证管理工具:管理 HTTP 认证和 API 密钥

常见问题解答

  • Q: 是否支持 OpenAPI v2.0 (Swagger)? A: 不支持
  • Q: 是否支持 OAuth 2.0 认证? A: 不支持

使用教程

使用依赖

# 克隆仓库
git clone https://github.com/sotayamashita/openapi-mcp-server.git
cd openapi-mcp-server

# 安装依赖
bun install

安装教程

# 使用本地文件运行服务器
bun run src/index.ts ./path/to/openapi.yml

# 使用 URL 运行服务器
bun run src/index.ts --api https://example.com/api-spec.json

调试方式

# 运行测试
bun vitest run

# 运行测试(观察模式)
bun vitest

# 运行测试(覆盖率)
bun vitest run --coverage

# 格式化代码
bun prettier . --write

许可证

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