JinDaGe - mcp-openapi MCP Details

article

README

🚀 MCP 协议集成到 IDE 项目

本项目旨在将 MCP 协议集成到 IDE 中，以实现一系列强大的 API 开发辅助功能，有效提升 API 开发的工作效率。

🚀 快速开始

本项目的目标是将 MCP 协议集成到 IDE 中，具体实现以下功能：

刷新 API 目录：定期更新可用 API 的信息。
获取 API 目录：检索所有已注册 API 及其详细信息。
搜索 API 操作：根据名称或 ID 查找特定操作。
搜索 API 架构：基于查询条件查找相关架构。
加载操作细节：通过操作 ID 或路径和方法获取操作详情。
加载架构细节：利用架构名称获取架构信息。

✨ 主要特性

工具支持

MCP 协议支持以下工具：

refresh-api-catalog：刷新 API 目录，返回成功消息。
get-api-catalog：获取完整的 API 目录信息。
search-api-operations：搜索操作，支持指定规格 ID 进行筛选。
search-api-schemas：搜索架构，同样支持指定规格 ID。
load-api-operation-by-operationId：通过规格 ID 和操作 ID 加载操作详情。
load-api-operation-by-path-and-method：利用规格 ID、路径和方法加载操作信息。
load-api-schema-by-schemaName：根据规格 ID 和架构名称获取架构细节。

示例提示功能

在 Cursor IDE 中，可使用以下示例提示与 API 交互：

探索可用 API

"显示目录中的所有可用 API 及其操作"
"列出所有 API 规格及其端点"

API 操作细节

"展示创建宠物 API 端点的详细信息"
"说明创建新宠物所需的参数"
"解释宠物创建端点的响应架构"

架构和模拟数据

"生成 Pet 架构的模拟数据"
"创建符合要求的请求负载以创建新宠物"
"展示基于架构的有效 Pet 对象示例"

代码生成

"为创建宠物 API 生成 Axios 客户端"
"生成 TypeScript 接口用于响应对象"
"编写调用创建宠物端点的 React 钩子"

API 集成辅助

"帮助实现宠物 API 的错误处理"
"为宠物 API 客户端生成单元测试"
"创建封装所有宠物相关 API 调用的服务类"

文档和使用

"展示使用宠物 API 的示例 curl 命令"
"生成 JSDoc 注释用于 API 客户端方法"
"创建 README 部分说明宠物 API 集成"

验证和类型

"为 Pet 模型生成 Zod 验证架构"
"创建 TypeScript 类型处理所有响应"
"帮助实现请求负载的验证逻辑"

API 搜索和发现

"查找所有与宠物管理相关的端点"
"显示所有接受文件上传的 API"
"列出返回分页结果的所有端点"

📚 详细文档

路线图

未来计划对项目进行以下改进：

语义搜索：增强搜索功能，支持自然语言处理。
远程规格同步：实现自动化的规格更新和版本控制。
跨平台集成：扩展对更多 IDE 和开发环境的支持。

任务说明

目标：集成 MCP 协议到 IDE 中以提升 API 开发效率。
范围：包括工具的开发、文档编写以及社区支持。
交付成果：完整实现的 MCP 工具集，详尽的中文文档和示例代码。

附加信息

技术要求：熟悉 Node.js 和 TypeScript 开发，具备 RESTful API 设计经验。
时间安排：需要在规定时间内完成开发、测试和文档编写。

通过以上步骤，您可以有效地将 MCP 协议集成到 IDE 中，显著提升 API 开发的工作效率。

mcp-openapi