Api Suggestion Server

🚀 API 建議服務器

API 建議服務器是一款基於 MCP 協議的實用工具，它能依據 OpenAPI 3.0 服務規範，為 Claude、GPT - 4 等 AI 模型提供 API 相關的上下文信息。該服務器可解析 YAML、JSON 格式或 URL 格式的 OpenAPI 規範，並通過 MCP 協議將 API 信息傳遞給 AI 模型，助力 AI 更好地理解和使用 API。

✨ 主要特性

• 多協議支持：支持 YAML、JSON 格式的 OpenAPI 文檔，也支持以 URL 方式提供的文檔。
• 智能建議：能根據輸入的使用場景，給出最相關的 API 端點建議。
• 易於擴展：可輕鬆將新的 OpenAPI 服務規範添加到系統中。

📦 安裝指南

1. 克隆項目倉庫：

git clone [your-repository-url]
cd api-mcp-server

2. 安裝依賴：

npm install

3. 啟動服務器：

npm start

💻 使用示例

新服務規範的添加

1. 將 OpenAPI 服務規範文件（YAML 或 JSON 格式）放入 schemas 目錄。
2. 在 server.config.ts 文件中新增相應的服務配置。

MCP 協議支持

AI 模型可通過調用以下工具與服務器交互：

suggest_api 工具

功能：提供與指定用途相關的 API 端點建議。

輸入參數：

• purpose：使用 API 的目的描述（字符串）

輸出結果：

• 相關 API 端點列表（包含服務名稱、路徑、請求方法和描述信息）

示例用法：

{
  "name": "suggest_api",
  "arguments": {
    "purpose": "用戶信息獲取"
  }
}

返回示例：

{
  "toolResult": [
    {
      "service": "示例 API",
      "path": "/users/{userId}",
      "method": "GET",
      "description": "根據 ID 獲取指定用戶信息"
    },
    {
      "service": "示例 API", 
      "path": "/users",
      "method": "GET",
      "description": "獲取所有用戶列表"  
    }
  ]
}

📚 詳細文檔

配置

編輯 server.config.ts 文件以添加新的服務配置。

開發指南

構建項目

npm run build

測試

1. 執行所有測試：

npm test

2. 啟用觀察模式運行測試（方便開發）：

npm run test:watch

3. 生成覆蓋率報告：

npm run test:coverage

目錄結構

api-mcp-server/
├── src/
│   ├── index.ts        # 主服務器代碼
│   ├── utils.ts        # 工具函數
│   ├── types.ts        # 類型定義
│   └── tests/          # 測試文件
├── schemas/            # OpenAPI 服務規範文件
├── server.config.ts    # 服務器配置
├── tsconfig.json       # TypeScript 配置
└── package.json        # 項目依賴管理

📄 許可證

MIT License

🤝 貢獻指南

歡迎提交問題和貢獻代碼！