MCP Openapi

🚀 MCP 協議集成到 IDE

本項目致力於將 MCP 協議集成到 IDE 中，旨在提升 API 開發的效率，為開發者提供便捷的 API 管理和操作體驗。

🚀 快速開始

本項目的主要目標是將 MCP 協議集成到 IDE 中，實現一系列 API 管理相關的功能，包括 API 目錄的刷新與獲取、API 操作和架構的搜索、操作和架構細節的加載等。

✨ 主要特性

1. 刷新 API 目錄：定期更新可用 API 的信息，確保 API 信息的及時性。
2. 獲取 API 目錄：能夠檢索所有已註冊 API 及其詳細信息，方便開發者全面瞭解 API 情況。
3. 搜索 API 操作：可根據名稱或 ID 查找特定操作，提高查找效率。
4. 搜索 API 架構：基於查詢條件查找相關架構，滿足不同的搜索需求。
5. 加載操作細節：通過操作 ID 或路徑和方法獲取操作詳情，深入瞭解 API 操作。
6. 加載架構細節：利用架構名稱獲取架構信息，方便架構的查看和使用。

📦 安裝指南

文檔未提及安裝步驟，暫不提供。

💻 使用示例

基礎用法

在 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"
"列出返回分頁結果的所有端點"

📚 詳細文檔

工具

以下是 MCP 協議支持的工具列表：

1. refresh-api-catalog：刷新 API 目錄，返回成功消息。
2. get-api-catalog：獲取完整的 API 目錄信息。
3. search-api-operations：搜索操作，支持指定規格 ID 進行篩選。
4. search-api-schemas：搜索架構，同樣支持指定規格 ID。
5. load-api-operation-by-operationId：通過規格 ID 和操作 ID 加載操作詳情。
6. load-api-operation-by-path-and-method：利用規格 ID、路徑和方法加載操作信息。
7. load-api-schema-by-schemaName：根據規格 ID 和架構名稱獲取架構細節。

路線圖

未來計劃包括以下改進：

1. 語義搜索：增強搜索功能，支持自然語言處理。
2. 遠程規格同步：實現自動化的規格更新和版本控制。
3. 跨平臺集成：擴展對更多 IDE 和開發環境的支持。

任務說明

• 目標：集成 MCP 協議到 IDE 中以提升 API 開發效率。
• 範圍：包括工具的開發、文檔編寫以及社區支持。
• 交付成果：完整實現的 MCP 工具集，詳盡的中文文檔和示例代碼。

附加信息

• 技術要求：熟悉 Node.js 和 TypeScript 開發，具備 RESTful API 設計經驗。
• 時間安排：需要在規定時間內完成開發、測試和文檔編寫。

通過以上步驟，您可以有效地將 MCP 協議集成到 IDE 中，顯著提升 API 開發的工作效率。