Docs RAG

🚀 MCP 文檔 RAG 服務器

本項目基於檢索的增強生成（RAG）技術，針對存儲在本地目錄中的文檔構建了一套系統。它是一個基於 TypeScript 的 MCP 服務器，允許用戶藉助大語言模型（LLM）對文檔進行查詢，並從本地存儲庫和文本文件中獲取上下文信息。

✨ 主要特性

資源

• 列出並訪問文檔：可通過 docs:// URI 進行訪問。
  • 文檔既可以是 Git 倉庫，也可以是文本文件。
  • 採用純文本 MIME 類型進行內容訪問。

工具

• list_documents：列出 DOCS_PATH 目錄下所有可用文檔。
  • 返回格式化的文檔列表。
  • 顯示可用文檔總數。
• rag_query：使用 RAG 查詢文檔。
  • 接受 document_id 和 query 參數。
  • 返回帶有文檔上下文的 AI 生成回覆。
• add_git_repository：將 Git 倉庫克隆到 docs 目錄，支持可選的稀疏檢出。
  • 接受 repository_url 參數。
  • 可選 document_name 參數，用於自定義文檔名稱（使用簡單的描述性名稱，不要帶有 '-docs' 後綴）。
  • 可選子目錄參數，用於稀疏檢出特定目錄。
  • 如果倉庫已存在，則自動拉取最新更改。
• add_text_file：下載文本文件到 docs 目錄。
  • 接受 file_url 參數。
  • 使用 wget 下載文件。

提示語

• guide_documents_usage：指導如何使用文檔和 RAG 功能。
  • 包含可用文檔的列表。
  • 提供 RAG 功能使用的提示信息。

📦 安裝指南

安裝依賴

npm install

構建服務器

npm run build

帶有自動重建功能的開發

npm run watch

📚 詳細文檔

設置

該服務器需要一個本地目錄來存儲文檔。默認使用 ~/docs，但你可以通過設置 DOCS_PATH 環境變量來配置不同的位置。

文檔結構

文檔目錄可以包含：

• Git 倉庫（已克隆的目錄）
• 帶有 .txt 擴展名的純文本文件

每個文檔都會使用 llama-index.ts 和 Google 的 Gemini 嵌入進行單獨索引。

API 密鑰

該服務器使用 Google 的 Gemini API 進行文檔索引和查詢。你需要設置你的 Gemini API 密鑰作為環境變量：

export GEMINI_API_KEY=your-api-key-here

你可以在 Google AI Studio 網站上獲取 Gemini API 密鑰。將此密鑰添加到你的殼配置文件或 Claude Desktop 的環境配置中。

安裝配置

要與 Claude Desktop 一起使用，請按照以下方式添加服務器配置：

• 在 MacOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
• 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json
• 在 Linux 上：~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "docs-rag": {
      "command": "npx",
      "args": ["-y", "@kazuph/mcp-docs-rag"],
      "env": {
        "DOCS_PATH": "/path/to/your/docs",
        "GEMINI_API_KEY": "your-api-key-here"
      }
    }
  }
}

💻 使用示例

安裝並啟動服務器

npm install -g @kazuph/mcp-docs-rag
mcp-docs-rag

使用 rag_query 工具進行查詢

# 示例：查詢文檔內容
mcp rag_query --id your-document-id --query "your-query-here"

添加新文檔或倉庫

添加 Git 倉庫

# 示例：添加 Git 倉庫
mcp add_git_repository --url https://github.com/username/repository.git

添加文本文件

# 示例：添加文本文件
mcp add_text_file --url https://example.com/document.txt

⚠️ 重要提示

• 確保你擁有所有訪問的資源和 API 的權限。
• 定期檢查更新以保持服務器的最佳性能。
• 處理敏感信息時，請遵守相關安全協議。