MCP Server Ragdocs

🚀 MCP-服務器-RAG 文檔管理指南

MCP-服務器是一個基於RAG（檢索增強生成）技術的文檔管理系統，它提供了多種實用工具，可幫助您高效地處理、搜索和管理文檔，提升文檔管理的效率和便捷性。

🚀 快速開始

您可以根據自己的需求選擇使用 Docker 安裝或者進行本地安裝。

使用 Docker 安裝

docker pull sanderkooger/mcp-server-ragdocs:latest

本地安裝

1. 克隆倉庫：

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

2. 安裝依賴：

   npm install
   

✨ 主要特性

• 文檔存儲：支持將多種格式的文檔（如PDF、Word、PPT等）上傳並存儲。
• 全文檢索：通過自然語言查詢快速找到相關文檔內容。
• URL抓取：從指定網頁提取鏈接，並分析其中的內容。
• 隊列管理：處理待索引的文檔，並監控處理進度。

📦 安裝指南

使用 Docker 安裝

docker pull sanderkooger/mcp-server-ragdocs:latest

本地安裝

1. 克隆倉庫：

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

2. 安裝依賴：

   npm install
   

📚 詳細文檔

配置指南

環境變量配置

在運行服務器之前，請設置以下環境變量：

日誌配置

日誌默認輸出到控制檯，您也可以通過修改配置文件來指定其他存儲位置。日誌格式遵循標準的結構化日誌規範。

項目架構

該服務器採用模塊化架構設計，各組件之間具有明確的職責分離。詳細的架構圖請參考ARCHITECTURE.md。

工具指南

搜索文檔

使用自然語言查詢搜索存儲的文檔，並返回相關段落和上下文。

輸入參數：

• query (字符串)：要搜索的文字，可以是自然語言、特定術語或代碼片段。
• limit (數字，可選)：最多返回的結果數（1 - 20，默認值為5）。

列出來源

列出當前存儲的所有文檔來源信息，包括URL、標題和更新時間等。

提取鏈接

從指定網頁中提取並分析所有URL。支持自動將提取的URL加入處理隊列。

輸入參數：

• url (字符串)：要爬取的完整網頁地址。
• add_to_queue (布爾值，可選)：是否將提取的URL加入隊列，默認為false。

刪除文檔

根據URL永久刪除指定文檔。每個URL必須與存儲時完全一致。

輸入參數：

• urls (字符串數組)：要刪除的URL列表。

列出隊列

顯示當前待處理的所有文檔URL，包括狀態和處理時間等信息。

運行隊列

逐個處理隊列中的文檔，並將其內容索引到數據庫中。提供詳細的處理進度反饋。

清空隊列

移除隊列中所有待處理的URL。操作不可逆，請謹慎使用。

項目結構

該包遵循模塊化設計原則，各部分功能明確。具體的文件和目錄結構請參考PROJECT_STRUCTURE.md。

📄 許可證

本項目採用MIT許可證開源。具體許可內容請查看LICENSE.md。

通過以上指南，您可以快速上手使用MCP-服務器來管理您的文檔資源。如需進一步瞭解，請隨時查閱詳細文檔或與開發團隊聯繫。