OpenAPI MCP Server

基本能力

产品定位

OpenAPI MCP Server 是一个 API 代理工具，旨在通过自然语言交互简化 API 的使用和测试。

核心功能

1. API 端点转换：将 OpenAPI v3.1 规范的 API 端点转换为 Claude 工具，使其能够被 Claude Desktop 识别和使用。
2. 参数理解：自动解析 API 的参数要求及其类型。
3. API 调用：代表用户执行 API 调用。
4. 文件上传支持：支持处理 multipart/form-data 类型的文件上传。
5. 响应处理：优化处理 JSON 和文本响应。

适用场景

1. 本地开发：通过自然语言测试和调试 API。
2. API 集成：快速测试第三方 API 或原型集成。
3. 文档学习：通过对话理解 API 的使用方法和示例。

工具列表

1. OpenAPI 规范清理工具：用于清理 OpenAPI 规范，使其更适合 LLM 读取。
2. Petstore API 示例：包含一个完整的 Petstore API 示例，用于测试和学习。

常见问题解答

1. 支持的文件类型：仅支持本地文件上传，不支持远程 URL。
2. 安全性：文件路径解析受限于用户权限，敏感文件需用户确认。
3. 性能：大文件通过流式传输优化内存使用。

使用教程

使用依赖

1. 确保已安装 Node.js 和 npm。
2. 安装 pnpm（可选但推荐）：

npm install -g pnpm

安装教程

1. 克隆项目或下载源代码。
2. 安装项目依赖：

pnpm install

1. 构建项目：

pnpm build

1. 将项目链接到全局 node_modules：

npm link

调试方式

1. 运行测试：

pnpm test

1. 启动 Claude Desktop 并配置 claude_desktop_config.json 以使用 MCP 服务器。
2. 修改代码后重新构建并重启 Claude Desktop：

pnpm build

许可证

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