Ragdocs

🚀 RagDocs 文檔知識圖譜服務器

RagDocs 是一個模型上下文協議（MCP）服務器，藉助 Qdrant 向量數據庫和 Ollama/OpenAI 嵌入模型，提供檢索增強生成（RAG）功能。它能通過向量相似度，實現文檔的語義搜索和高效管理。

🚀 快速開始

在使用 RagDocs 之前，需要滿足一些先決條件，然後進行安裝和配置。

先決條件

• Node.js 16 或更高版本
• 下列之一的 Qdrant 設置：
  • 使用 Docker 的本地實例（免費）
  • 帶 API 密鑰的 Qdrant 雲賬戶（託管服務）
• 下列之一用於嵌入模型：
  • 本地運行的 Ollama（默認，免費）
  • OpenAI API 密鑰（可選，付費）

安裝

npm install -g @mcpservers/ragdocs

配置

MCP 服務器

編輯 config.json 文件：

{
    "mcp_port": 5000,
    "db_path": "./db",
    "log_level": "info"
}

啟動 MCP 服務器

在終端運行：

node index.js

環境變量

• MCP_PORT：指定 MCP 服務器的端口（默認：5000）
• DB_PATH：指定數據庫文件的存儲路徑（默認：./db）
• LOG_LEVEL：設置日誌級別（info/debug/warn/error）

安裝依賴

在終端運行：

npm install express pg jsonwebtoken cors dotenv sequelize

✨ 主要特性

• 添加帶有元數據的文檔
• 通過語義相似度搜索文檔
• 列出並組織文檔
• 刪除文檔
• 支持 Ollama（免費）和 OpenAI（付費）嵌入模型
• 自動文本分塊和嵌入生成
• 使用 Qdrant 進行向量存儲

💻 使用示例

基礎用法

1. add_document

將文檔添加到 RAG 系統。

// 示例代碼
// 假設已經有了相應的文檔信息
const url = 'https://example.com/doc';
const content = '這是文檔的內容';
const metadata = {
    title: '示例文檔',
    contentType: 'text/markdown'
};

// 調用 add_document 工具添加文檔
// 這裡只是示例，實際調用需要根據具體實現
// add_document(url, content, metadata);

2. search_documents

使用語義相似度搜索存儲的文檔。

// 示例代碼
const query = '查找相關文檔';
const options = {
    limit: 5,
    scoreThreshold: 0.7,
    filters: {
        domain: 'example',
        hasCode: false,
        after: '2024-01-01T00:00:00Z',
        before: '2024-12-31T23:59:59Z'
    }
};

// 調用 search_documents 工具進行搜索
// 這裡只是示例，實際調用需要根據具體實現
// search_documents(query, options);

3. list_documents

列出所有存儲的文檔，支持分頁和分組選項。

// 示例代碼
const page = 1;
const pageSize = 20;
const groupByDomain = false;
const sortBy = 'timestamp';
const sortOrder = 'asc';

// 調用 list_documents 工具列出文檔
// 這裡只是示例，實際調用需要根據具體實現
// list_documents({
//     page,
//     pageSize,
//     groupByDomain,
//     sortBy,
//     sortOrder
// });

4. delete_document

從 RAG 系統中刪除文檔。

// 示例代碼
const urlToDelete = 'https://example.com/doc';

// 調用 delete_document 工具刪除文檔
// 這裡只是示例，實際調用需要根據具體實現
// delete_document(urlToDelete);

高級用法

在實際使用中，可以根據具體需求組合使用這些工具，例如先添加多個文檔，然後進行搜索和篩選，最後根據需要刪除某些文檔。

📚 詳細文檔

可用工具

1. add_document

將文檔添加到 RAG 系統。

2. search_documents

使用語義相似度搜索存儲的文檔。

3. list_documents

列出所有存儲的文檔，支持分頁和分組選項。

4. delete_document

從 RAG 系統中刪除文檔。

📄 許可證

Apache License 2.0