OpenAPI MCP Server
2025.03.10
65
JavaScriptAPI 中间件开发工具开发效率
OpenAPI MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，它将 OpenAPI 端点暴露为 MCP 资源。该服务器允许大型语言模型通过 MCP 协议发现并与由 OpenAPI 规范定义的 REST API 进行交互。
View on GitHub
Overview
基本能力
产品定位
OpenAPI MCP Server 是一个中间件，旨在桥接大型语言模型与 REST API 之间的交互，通过 MCP 协议提供标准化的 API 访问方式。
核心功能
- 将 OpenAPI 规范的 REST API 暴露为 MCP 资源
- 支持通过环境变量或命令行参数进行配置
- 提供开发工具链（构建、类型检查、代码质量检查等）
- 支持开发模式下的自动重建和重启
- 提供调试日志输出
适用场景
- 需要让大型语言模型访问 REST API 的场景
- 需要标准化 API 访问方式的开发环境
- 需要快速原型开发和测试的 API 项目
工具列表
npm run build- 构建 TypeScript 源代码npm run clean- 清除构建产物npm run typecheck- 运行 TypeScript 类型检查npm run dev- 监视源文件变化并自动重建npm run inspect-watch- 运行检查器并自动重载变化npm run lint- 运行 ESLint
常见问题解答
- 如何配置 API 访问？ 通过环境变量或命令行参数配置 API_BASE_URL、OPENAPI_SPEC_PATH 和 API_HEADERS
- 如何查看调试日志？ 在开发模式下查看终端输出，或直接运行时重定向 stderr 到文件
使用教程
使用依赖
- 需要安装 Node.js 和 npm
- 需要配置 Claude Desktop 环境
安装教程
- 在 Claude Desktop 配置文件中添加以下配置：
{
"mcpServers": {
"openapi": {
"command": "npx",
"args": ["-y", "@ivotoby/openapi-mcp-server"],
"env": {
"API_BASE_URL": "https://api.example.com",
"OPENAPI_SPEC_PATH": "https://api.example.com/openapi.json",
"API_HEADERS": "Authorization:Bearer token123,X-API-Key:your-api-key"
}
}
}
}
- 替换环境变量为实际的 API 配置
调试方式
- 启动开发环境：
npm run inspect-watch
- 在终端查看调试日志
- 或直接运行时重定向错误输出：
npm run inspect 2>debug.log