MCP Ragdocs

🚀 RAG 文檔 MCP 服務器

RAG 文檔 MCP 服務器是一個實現的 MCP 服務器，它能提供文檔檢索和處理功能，並藉助向量搜索提供工具支持。這使得 AI 助手可以利用相關文檔上下文來增強其響應內容，提升回答的準確性和全面性。

✨ 主要特性

• 🔍 基於向量的文檔搜索和檢索：利用向量技術高效查找所需文檔。
• 🌐 支持多個文檔來源：可整合不同渠道的文檔資源。
• 📖 語義搜索功能：理解查詢語義，精準定位相關文檔。
• 🤖 自動化文檔處理：提高文檔處理效率。
• 💪 即時上下文增強 LLM 能力：讓大語言模型的響應更具針對性。

🛠️ 工具

search_documentation

通過自然語言查詢在存儲的文檔中進行搜索。返回匹配的摘錄及其上下文，按相關性排序。

• 輸入：
  • query (字符串)：要在文檔中搜索的文本。可以是自然語言查詢、特定術語或代碼片段。
  • limit (數字，可選)：要返回的結果的最大數量（1 - 20，默認值：5）。較大的限制會提供更多全面的結果，但可能會增加處理時間。

list_sources

列出當前存儲在系統中的所有文檔來源。返回一個詳盡的列表，包括所有索引的文檔源 URL、標題和最後更新時間。使用此工具可瞭解可用以搜索的文檔內容，或驗證是否已索引特定來源。

extract_urls

從指定網頁中提取並分析所有 URL。此工具爬取指定網頁、識別所有超鏈接，並可選擇將它們添加到處理隊列中進行後續處理。

• 輸入：
  • url (字符串)：要分析的網頁完整 URL（必須包含協議，例如 https://）。該頁面必須公開可訪問。
  • add_to_queue (布爾值，可選)：如果為 true，則自動將提取的 URL 添加到處理隊列中進行後續索引。在大型網站上使用時請謹慎以避免隊列過多。

remove_documentation

通過其 URL 從系統中永久刪除特定文檔來源。此操作會影響未來的搜索結果。

• 輸入：
  • urls (字符串數組)：要從數據庫中移除的 URL 列表。每個 URL 必須與添加時使用的 URL 完全匹配。

list_queue

列出當前在文檔處理隊列中等待的所有 URL。顯示待處理文檔來源，這些將在調用 run_queue 時進行處理。使用此工具可監控隊列狀態、驗證 URL 是否正確添加，或檢查處理 backlog。

run_queue

處理並索引所有當前位於文檔處理隊列中的 URL。每個 URL 將按順序處理，並提供適當的錯誤處理和重試邏輯。在處理過程中會提供進度更新。長時間運行的操作將在隊列清空或發生不可恢復的錯誤之前繼續進行。

clear_queue

從文檔處理隊列中移除所有待處理 URL。使用此工具可開始清空隊列、移除不需要的 URL，或取消待處理任務。此操作是立即且永久的 - 如果需要再次處理這些 URL，則需要重新添加它們。

💻 使用示例

搜索文檔

輸入：

{
    "query": "如何配置 RAG 文檔工具？",
    "limit": 5
}

輸出：

[
    {"content": "步驟 1：安裝所需的依賴項。", "source": "documentation/installation.md"},
    {"content": "步驟 2：配置環境變量。", "source": "documentation/configuration.md"},
    {"content": "步驟 3：啟動服務。", "source": "documentation/getting-started.md"}
]

列出來源

輸入：

{
    "input": "None"
}

輸出：

[
    {"url": "documentation/installation.md", "title": "安裝指南", "last_updated": "2024-01-01"},
    {"url": "documentation/configuration.md", "title": "配置指南", "last_updated": "2024-01-02"}
]

提取 URL

輸入：

{
    "url": "https://example.com/documentation",
    "add_to_queue": true
}

輸出：

{
    "status": "success",
    "message": "URL 已添加到隊列中。"
}

⚙️ 配置

與 Claude Desktop 結合使用

在 claude_desktop_config.json 文件中添加以下內容：

{
    "MCP server": {
        "enabled": true,
        "configuration": {
            "type": "RAGDocumentation"
        }
    }
}

🌐 環境變量

此文檔詳細描述了 RAG 文檔 MCP 服務器的功能、工具和配置。通過結合這些功能，您可以有效地管理和檢索文檔內容以支持 AI 應用程序。