Ragdocs (Vector Documentation Search)

🚀 RAG 文档 MCP 服务器

这是一个基于向量搜索工具的 MCP 服务器实现，可用于检索和处理文档。借助该服务器，AI 助手能够利用相关文档上下文，增强其响应的准确性和全面性。

✨ 主要特性

• 基于向量的文档搜索与检索：高效定位所需文档。
• 支持多个文档来源：可整合不同渠道的文档资源。
• 语义搜索功能：理解用户查询的语义，提供更精准的结果。
• 自动化文档处理：提高文档处理效率。
• 实时上下文增强 LLM（大语言模型）：让大语言模型的回复更具针对性。

📦 安装指南

文档未提供安装步骤相关内容，跳过此章节。

💻 使用示例

基础用法

本项目提供了多个工具，以下是部分工具的使用示例：

search_documentation

# 搜索文档
# 输入查询文本和返回结果的最大数量
# 此工具会在存储的文档中进行搜索，并返回匹配的摘录及其上下文，按相关性排序
from your_module import search_documentation
query = "特定术语"
limit = 5
result = search_documentation(query, limit)

list_sources

# 列出所有文档来源
# 此工具会返回所有索引文档的综合列表，包括源 URL、标题和最后更新时间
from your_module import list_sources
sources = list_sources()

高级用法

extract_urls

# 从指定网页中提取并分析所有 URL
# 输入要分析的网页 URL 和是否将提取的 URL 添加到处理队列的标志
# 此工具会爬取指定网页，识别其中的所有超链接，并可选地将它们添加到处理队列中
from your_module import extract_urls
url = "https://example.com"
add_to_queue = True
urls = extract_urls(url, add_to_queue)

remove_documentation

# 通过 URL 永久移除特定文档来源
# 输入要移除的 URL 列表
# 此操作会影响未来的搜索结果
from your_module import remove_documentation
urls = ["https://example.com/doc1", "https://example.com/doc2"]
remove_documentation(urls)

📚 详细文档

工具详细说明

search_documentation

通过自然语言查询在存储的文档中进行搜索。返回匹配的摘录及其上下文，按相关性排序。 输入：

• query (字符串)：要在文档中搜索的文本。可以是自然语言查询、特定术语或代码片段。
• limit (数字，可选)：要返回的最大结果数（1 - 20，默认值：5）。较大的限制会提供更全面的结果，但可能会导致处理时间更长。

list_sources

列出当前系统中存储的所有文档来源。返回所有索引文档的综合列表，包括源 URL、标题和最后更新时间。使用此工具了解可用以搜索的文档内容或验证特定来源是否已索引。

extract_urls

从指定网页中提取并分析所有 URL。此工具会爬取指定网页，识别其中的所有超链接，并可选地将它们添加到处理队列中。 输入：

• url (字符串)：要分析的完整网页 URL（必须包含协议，例如 https://）。该页面必须是公开可访问的。
• add_to_queue (布尔值，可选)：如果为 true，则自动将提取的 URL 添加到处理队列中以供后续索引。在大型网站上使用时要谨慎以免队列过多。

remove_documentation

通过其 URL 永久移除特定文档来源。此操作会影响未来的搜索结果。 输入：

• urls (字符串数组)：要从数据库中移除的 URL 列表。每个 URL 必须与添加文档时使用的 URL 完全匹配。

list_queue

列出当前在文档处理队列中等待的所有 URL。显示待处理的文档来源，这些将在调用 run_queue 时进行处理。使用此工具监控队列状态、验证 URL 是否正确添加或检查处理 backlog。

run_queue

处理并索引文档队列中的所有 URL。每个 URL 将按顺序处理，并提供错误处理和重试逻辑。在处理过程中会提供进度更新。长时间运行的操作将在队列为空或发生不可恢复的错误之前继续进行。

clear_queue

从文档处理队列中移除所有待处理的 URL。使用此工具当需要重新开始、移除不需要的 URL 或取消待处理操作时清空队列。此操作是立即且永久性的 - 如果需要以后再次处理，将需要重新添加这些 URL。

使用场景

RAG 文档工具适用于：

• 增强 AI 响应的相关文档上下文。
• 构建具有文档意识的 AI 助手。
• 创建上下文感知工具以供开发人员使用。
• 实现语义文档搜索。
• 增强现有知识库。

配置

与 Claude Desktop 一起使用

在 claude_desktop_config.json 中添加以下内容：

{
  "mcpServers": {
    "rag-docs": {
      "command": "npx",
      "args": [
        "-y",
        "@hannesrudolph/mcp-ragdocs"
      ],
      "env": {
        "OPENAI_API_KEY": "",
        "QDRANT_URL": "",
        "QDRANT_API_KEY": ""
      }
    }
  }
}

需要设置以下环境变量：

• OPENAI_API_KEY：用于与 OpenAI API 通信的密钥。
• QDRANT_URL：Qdrant 向量数据库服务的 URL。
• QDRANT_API_KEY：访问 Qdrant 服务所需的 API 密钥。

🔧 技术细节

文档未提供技术细节相关内容，跳过此章节。

📄 许可证

项目采用MIT License许可。

致谢

感谢Hannes RAG为这个项目奠定的基础。

📋 待办事项

• [ ] 实现文档加载和索引功能
• [ ] 添加搜索结果排序选项
• [ ] 支持更多文档格式
• [ ] 增加错误处理和日志记录