API Documentation

🚀 MCP 專家服務器

MCP 專家服務器是一個基於模型上下文協議（Model Context Protocol）的服務器，藉助 Claude AI 實現智能查詢生成與文檔輔助功能。它能夠深入分析您的 API 文檔，並提供兩大實用工具：

• create-query：依據自然語言請求生成查詢。
• documentation：根據問題提供相關文檔信息。

🚀 快速開始

MCP 專家服務器的使用需要滿足一定的先決條件，完成安裝、設置等步驟，下面為您詳細介紹。

✨ 主要特性

• 利用 Claude AI 提供智能查詢生成和文檔輔助功能。
• 提供 create-query 和 documentation 兩個實用工具。
• 支持多種 API 文檔文件格式，包括 .txt、.md 和 .json。

📦 安裝指南

先決條件

• 需安裝 Node.js 18 及以上版本。
• 準備好 Anthropic API 密鑰用於 Claude。

安裝步驟

1. 克隆倉庫。
2. 安裝依賴項，執行以下命令：

npm install

3. 創建一個 .env 文件，並添加您的 Anthropic API 密鑰：

ANTHROPIC_API_KEY=your_api_key_here

🔧 設置

在運行服務器之前，請按以下步驟進行設置：

1. 構建項目並運行設置腳本：

npm run build
npm run setup

此操作將完成以下任務：

• 創建所需的目錄（docs/ 和 prompts/）。
• 創建默認提示文件。
• 生成初始服務描述。

2. 將您的 API 文檔文件添加到 docs/ 目錄中，支持 .txt、.md 和 .json 文件。
3. 您可以選擇性地自定義 prompts/ 目錄中的提示：
   • system-prompt.txt：Claude 的主要系統提示。
   • tool-metadata.txt：工具描述的額外上下文。
   • query-metadata.txt：查詢生成的額外上下文。
   • service-description.txt：自動生成的服務描述。

💻 使用示例

獨立服務器

啟動服務器，執行以下命令：

npm start

該服務器通過 Model Context Protocol 提供兩個工具：

基礎用法

• create-query：根據自然語言請求生成查詢。

{
    "name": "create-query",
    "arguments": {
        "request": "查找過去一週內註冊的所有用戶"
    }
}

• documentation：從文檔中獲取信息。

{
    "name": "documentation",
    // 這裡原文檔未完整給出內容，保持原樣
}