Ragdocs (Vector Documentation Search)

🚀 RAG 文檔 MCP 服務器

這是一個基於向量搜索工具的 MCP 服務器實現，可用於檢索和處理文檔。藉助該服務器，AI 助手能夠利用相關文檔上下文，增強其響應的準確性和全面性。

✨ 主要特性

• 基於向量的文檔搜索與檢索：高效定位所需文檔。
• 支持多個文檔來源：可整合不同渠道的文檔資源。
• 語義搜索功能：理解用戶查詢的語義，提供更精準的結果。
• 自動化文檔處理：提高文檔處理效率。
• 即時上下文增強 LLM（大語言模型）：讓大語言模型的回覆更具針對性。

📦 安裝指南

文檔未提供安裝步驟相關內容，跳過此章節。

💻 使用示例

基礎用法

本項目提供了多個工具，以下是部分工具的使用示例：

search_documentation

# 搜索文檔
# 輸入查詢文本和返回結果的最大數量
# 此工具會在存儲的文檔中進行搜索，並返回匹配的摘錄及其上下文，按相關性排序
from your_module import search_documentation
query = "特定術語"
limit = 5
result = search_documentation(query, limit)

list_sources

# 列出所有文檔來源
# 此工具會返回所有索引文檔的綜合列表，包括源 URL、標題和最後更新時間
from your_module import list_sources
sources = list_sources()

高級用法

extract_urls

# 從指定網頁中提取並分析所有 URL
# 輸入要分析的網頁 URL 和是否將提取的 URL 添加到處理隊列的標誌
# 此工具會爬取指定網頁，識別其中的所有超鏈接，並可選地將它們添加到處理隊列中
from your_module import extract_urls
url = "https://example.com"
add_to_queue = True
urls = extract_urls(url, add_to_queue)

remove_documentation

# 通過 URL 永久移除特定文檔來源
# 輸入要移除的 URL 列表
# 此操作會影響未來的搜索結果
from your_module import remove_documentation
urls = ["https://example.com/doc1", "https://example.com/doc2"]
remove_documentation(urls)

📚 詳細文檔

工具詳細說明

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。

使用場景

RAG 文檔工具適用於：

• 增強 AI 響應的相關文檔上下文。
• 構建具有文檔意識的 AI 助手。
• 創建上下文感知工具以供開發人員使用。
• 實現語義文檔搜索。
• 增強現有知識庫。

配置

與 Claude Desktop 一起使用

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

{
  "mcpServers": {
    "rag-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@hannesrudolph/mcp-ragdocs"
      ],
      "env": {
        "OPENAI_API_KEY": "",
        "QDRANT_URL": "",
        "QDRANT_API_KEY": ""
      }
    }
  }
}

需要設置以下環境變量：

• OPENAI_API_KEY：用於與 OpenAI API 通信的密鑰。
• QDRANT_URL：Qdrant 向量數據庫服務的 URL。
• QDRANT_API_KEY：訪問 Qdrant 服務所需的 API 密鑰。

🔧 技術細節

文檔未提供技術細節相關內容，跳過此章節。

📄 許可證

項目採用MIT License許可。

致謝

感謝Hannes RAG為這個項目奠定的基礎。

📋 待辦事項

• [ ] 實現文檔加載和索引功能
• [ ] 添加搜索結果排序選項
• [ ] 支持更多文檔格式
• [ ] 增加錯誤處理和日誌記錄