RAG Docs

🚀 MCP 文檔檢索服務器

MCP 文檔檢索服務器可幫助用戶高效地添加、搜索和管理文檔。通過配置不同的服務和使用相應工具，用戶能方便地構建自己的文檔檢索系統。

🚀 快速開始

若要快速使用 MCP 文檔檢索服務器，可參考以下步驟：

1. 克隆倉庫：

git clone https://github.com/qpd-v/mcp-server-ragdocs.git
cd mcp-server-ragdocs

2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

📦 安裝指南

克隆倉庫

git clone https://github.com/qpd-v/mcp-server-ragdocs.git
cd mcp-server-ragdocs

安裝依賴項

npm install

構建項目

npm run build

📚 詳細文檔

配置指南

環境變量配置

Qdrant 服務配置

• QDRANT_URL（必需）：Qdrant 實例的 URL 地址
  • 本地運行時使用：http://localhost:6333
  • 使用雲服務時：https://your-cluster-url.qdrant.tech
• QDRANT_API_KEY（必需，用於雲服務）：你的 Qdrant 雲 API 密鑰

嵌入式模型配置

• EMBEDDING_PROVIDER（可選）：選擇 'ollama'（默認）或 'openai'
• EMBEDDING_MODEL（可選）：
  • 使用 Ollama 時，默認為 'nomic-embed-text'
  • 使用 OpenAI 時，默認為 'text-embedding-3-small'
• OLLAMA_URL（可選）：Ollama 實例的 URL 地址（默認 http://localhost:11434）
• OPENAI_API_KEY（必需，若使用 OpenAI）：你的 OpenAI API 密鑰

可用工具

1. add_documentation

   • 從指定 URL 添加文檔到 RAG 數據庫
   • 參數：
     • url：要獲取的文檔 URL 地址

2. search_documentation

   • 在存儲的文檔中進行搜索
   • 參數：
     • query：搜索查詢內容
     • limit（可選）：返回結果的最大數量（默認 5）

3. list_sources

   • 列出當前存儲的所有文檔來源
   • 無參數要求

示例用法

在 Claude Desktop 或其他 MCP 兼容客戶端中：

1. 添加文檔：

添加此文檔：https://docs.example.com/api

2. 搜索文檔：

搜索文檔以獲取關於身份驗證的信息

3. 列出來源：

有哪些可用的文檔來源？

開發指南

克隆倉庫

git clone https://github.com/qpd-v/mcp-server-ragdocs.git
cd mcp-server-ragdocs

安裝依賴項

npm install

構建項目

npm run build

本地運行

npm start

故障排除

常見問題

1. Qdrant 連接錯誤

錯誤：無法連接到 Qdrant 服務 http://localhost:6333

• 檢查 Docker 是否在運行
• 確認 Qdrant 容器是否正常運行：docker ps | grep qdrant
• 嘗試重啟容器

2. Ollama 模型未找到

錯誤：模型 nomic-embed-text 未找到

• 運行：ollama pull nomic-embed-text
• 驗證模型是否已安裝：ollama list

3. 配置路徑問題

• Windows 系統中，確保使用正確的路徑分隔符（反斜槓）
• 檢查 .env 文件中的變量是否正確設置

4. 端口衝突

錯誤：EADDRINUSE @localhost:5000

• 檢查是否有其他程序佔用 5000 端口
• 嘗試更換為其他可用端口

貢獻指南

提交代碼

1. 創建功能分支：

git checkout -b feature/your-feature-name

2. 提交更改：

git add .
git commit -m "描述你所做的修改"
git push origin feature/your-feature-name

3. 創建 Pull Request 到主分支

問題報告

• 提交 ISSUE 前，請先搜索現有問題，避免重複提交
• 提供詳細的錯誤信息和復現步驟

📄 許可證

MIT

感謝使用 MCP 文檔檢索服務器！如需更多信息，請訪問我們的 GitHub 倉庫。