@reapi/mcp-openapi

基本能力

产品定位

mcp-openapi 是一个用于 API 开发和集成的工具，旨在通过 MCP 协议将 OpenAPI 规范与 LLM 驱动的开发工具集成，提升开发效率。

核心功能

• 从目录加载多个 OpenAPI 规范
• 通过 MCP 协议暴露 API 操作和模式
• 支持解引用的模式以提供完整的 API 上下文
• 维护所有可用 API 的目录
• 支持在 IDE 中通过自然语言查询 API 操作和模式

适用场景

• 在开发工具中集成 OpenAPI 规范
• 为 LLM 提供 API 上下文以支持代码生成和智能补全
• 团队协作开发 API 时管理多个规范

工具列表

1. refresh-api-catalog - 刷新 API 目录
2. get-api-catalog - 获取 API 目录
3. search-api-operations - 搜索 API 操作
4. search-api-schemas - 搜索 API 模式
5. load-api-operation-by-operationId - 通过 operationId 加载操作
6. load-api-operation-by-path-and-method - 通过路径和方法加载操作
7. load-api-schema-by-schemaName - 通过模式名称加载模式

常见问题解答

• 如何配置 Cursor IDE 以使用 mcp-openapi？ 可以通过项目特定的 .cursor/mcp.json 或全局的 ~/.cursor/mcp.json 配置文件进行配置。
• 如何刷新 API 目录？ 在 Cursor 的聊天面板中输入 "Please refresh the API catalog" 或 "Reload the OpenAPI specifications"。
• 如何解决 API 规范冲突？ 使用 x-spec-id 为每个规范指定唯一的 ID 以避免命名冲突。

使用教程

使用依赖

• Node.js 环境
• npm 或 yarn

安装教程

1. 通过 npm 安装： bash npm install -g @reapi/mcp-openapi
2. 配置 Cursor IDE：
3. 创建 .cursor/mcp.json 文件并添加以下内容： json { "mcpServers": { "@reapi/mcp-openapi": { "command": "npx", "args": ["-y", "@reapi/mcp-openapi@latest", "--dir", "./specs"], "env": {} } } }
4. 在 Cursor IDE 中启用 mcp-openapi 服务器

调试方式

1. 启动服务器： bash npx @reapi/mcp-openapi --dir ./specs
2. 检查日志以确认服务器正常运行
3. 在 Cursor IDE 中测试 API 查询功能

许可证

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