🚀 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