RAG Documentation

🚀 RAG 文檔 MCP 服務器

一個 MCP 服務器實現，提供通過向量搜索檢索和處理文檔的工具，使 AI 助手能夠通過相關文檔上下文增強其響應。

🚀 快速開始

安裝依賴項

確保已安裝以下工具：

• Node.js (推薦版本 14+)
• Docker (可選，用於 Docker Compose)

克隆倉庫

git clone https://github.com/your-repository.git
cd mcp-ragdocs

運行服務器

npm install
node index.js

默認情況下，服務器將在 http://localhost:3030 上運行。

✨ 主要特性

此 MCP 服務器提供以下功能：

1. 文檔檢索：通過向量搜索高效檢索相關文檔。
2. 上下文增強：使 AI 助手能夠引用和理解文檔內容，提升響應質量。
3. 多語言支持：支持多種語言的文檔處理與檢索。

📦 安裝指南

Docker Compose 設置

使用以下 docker-compose.yml 文件啟動服務：

version: '3'
services:
  mcp-ragdocs:
    build: .
    ports:
      - "3030:3030"
    environment:
      - EMBEDDING_PROVIDER=ollama
      - OPENAI_API_KEY=your-api-key-here

運行命令：

docker-compose up --build

📚 詳細文檔

Web 界面

訪問 http://localhost:3030 使用默認的 Web 界面進行文檔檢索和管理。

配置

Cline 配置

在 .env 文件中設置以下環境變量：

EMBEDDING_PROVIDER=ollama  # 可選值：ollama 或 openai
OPENAI_API_KEY=your-api-key-here  # 必填（如果使用 OpenAI）
QDRANT_URL=http://localhost:6333  # 可選，默認為 http://localhost:6333

Claude Desktop 配置

在 config.json 文件中設置以下內容：

{
  "EMBEDDING_PROVIDER": "ollama",
  "OPENAI_API_KEY": "your-api-key-here",
  "QDRANT_URL": "http://localhost:6333"
}

默認配置

系統默認使用 Ollama 作為嵌入提供程序。為了最佳可靠性：

1. 安裝並運行 Ollama 本地。
2. 配置 OpenAI 作為備用（推薦）：

{
  "EMBEDDING_MODEL": "nomic-embed-text", // 可選
  "FALLBACK_PROVIDER": "openai",
  "FALLBACK_MODEL": "text-embedding-3-small",
  "OPENAI_API_KEY": "your-api-key-here"
}

此配置確保：

• 使用 Ollama 進行快速本地嵌入生成。
• 自動 fallback 到 OpenAI 如果 Ollama 失敗。
• 只在必要時進行外部 API 調用。

注意：系統將根據提供程序自動使用適當的向量維度：

• Ollama (nomic-embed-text)：768 維度
• OpenAI (text-embedding-3-small)：1536 維度

致謝

該項目是 qpd-v/mcp-ragdocs 的一個分支，最初由 qpd-v 開發。原始項目提供了此實現的基礎。特別感謝原始作者 qpd-v 在初始版本上的創新工作。這個分支經過 Rahul Retnan 的改進，添加了更多功能。

🔧 技術細節

故障排除

服務器未啟動（端口衝突）

如果 MCP 服務器因端口衝突而無法啟動，請執行以下步驟：

1. 識別並終止使用端口 3030 的進程：

npx kill-port 3030

2. 重新啟動 MCP 服務器
3. 如果問題仍然存在，請檢查是否有其他進程佔用該端口：

lsof -i :3030

4. 如果需要，可以在配置中更改默認端口。