MCP Rag Server

🚀 mcp-rag-server

一個基於模型上下文協議（MCP）的服務器，支持檢索增強生成（RAG）。它能夠索引文檔，並通過MCP協議為大型語言模型提供相關信息，有效提升模型處理複雜任務的能力。

🚀 快速開始

1. 安裝依賴

   npm install
   

2. 啟動服務器

   npm start
   

3. 使用示例命令進行交互

   node example.js
   

✨ 主要特性

• 文檔索引：讀取文件，根據 CHUNK_SIZE 分割文本，並進行排隊以供嵌入處理。
• 嵌入處理：按順序將每個分塊發送到嵌入 API，結果存儲在 SQLite 數據庫中。
• 查詢功能：對查詢內容進行嵌入處理，從向量存儲庫中檢索最相關的文本分塊，並將其返回給客戶端。

📦 安裝指南

npm install mcp-rag-server

💻 使用示例

基礎用法

通用 MCP 客戶端配置

{
  "mcpServers": {
    "rag": {
      "command": "npx",
      "args": ["-y", "mcp-rag-server"],
      "env": {
        "BASE_LLM_API": "http://localhost:11434/v1",
        "EMBEDDING_MODEL": "nomic-embed-text",
        "VECTOR_STORE_PATH": "./vector_store",
        "CHUNK_SIZE": "500"
      }
    }
  }
}

示例交互

# 索引文檔
>> tool:embedding_documents {"path":"./docs"}

# 檢查狀態
>> resource:embedding-status

<< rag://embedding/status
當前完成數：123
失敗數：45
總數量：678

高級用法

MCP 工具

# 索引文檔
>> tool:embedding_documents {"path":"./docs"}

# 查詢文檔內容
>> tool:query_document {"query":"查詢內容", "numberOfChunks":3}

# 獲取所有文檔 URI
>> resource:rag://documents

# 獲取單個文檔內容
>> resource:rag://document/path/to/document.txt

MCP 資源

• rag://documents：列出所有文檔的 URI。
• rag://document/{path}：獲取指定路徑的文檔內容。
• rag://query-document/{numberOfChunks}/{query}：按數量獲取與查詢相關的文檔內容。
• rag://embedding/status：查看當前索引狀態（已完成、失敗、總數）。

📚 詳細文檔

配置選項

開發

npm install
npm run build      # 編譯 TypeScript 代碼
npm start          # 啟動服務器
npm run watch      # 監控文件變化

貢獻

歡迎貢獻！請在 GitHub 上打開問題或拉取請求。

📄 許可證

MIT 2025 Quan Le