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-服务器来管理您的文档资源。如需进一步了解，请随时查阅详细文档或与开发团队联系。