mcp-ragdocs

by hannesrudolph
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Uses OpenAI's API for embeddings generation to power the vector search capabilities of the RAG documentation system

RAG 文档 MCP 服务器

MCP 服务器实现提供了通过矢量搜索检索和处理文档的工具,使 AI 助手能够通过相关文档上下文增强他们的响应。

特征

  • 基于矢量的文档搜索和检索
  • 支持多种文档来源
  • 语义搜索功能
  • 自动化文档处理
  • 法学硕士 (LLM) 的实时上下文增强

工具

搜索文档

使用自然语言查询搜索存储的文档。返回符合上下文的摘录,并按相关性排序。

输入:

  • query (字符串):要在文档中搜索的文本。可以是自然语言查询、特定术语或代码片段。
  • limit (数字,可选):返回结果的最大数量(1-20,默认值:5)。限制值越高,返回结果越全面,但处理时间也越长。

列表来源

列出系统中当前存储的所有文档来源。返回所有已索引文档的完整列表,包括来源 URL、标题和最后更新时间。使用此列表可以了解哪些文档可供搜索,或验证特定来源是否已被索引。

提取网址

提取并分析给定网页的所有 URL。此工具会抓取指定网页,识别所有超链接,并选择性地将其添加到处理队列中。

输入:

  • url (字符串):待分析网页的完整 URL(必须包含协议,例如 https://)。该页面必须可公开访问。
  • add_to_queue (布尔值,可选):如果设置为 true,则自动将提取的 URL 添加到处理队列中,以便稍后进行索引。在大型网站上请谨慎使用,以避免队列过长。

删除文档

根据 URL 从系统中移除特定文档来源。移除操作是永久性的,并将影响未来的搜索结果。

输入:

  • urls (string[]):要从数据库中移除的 URL 数组。每个 URL 必须与添加文档时使用的 URL 完全匹配。

列表队列

列出当前在文档处理队列中等待的所有 URL。显示调用 run_queue 时将处理的待处理文档源。使用此方法可以监控队列状态、验证 URL 是否已正确添加,或检查处理积压情况。

运行队列

处理并索引当前文档队列中的所有 URL。每个 URL 均按顺序处理,并采用适当的错误处理和重试逻辑。处理过程中会提供进度更新。长时间运行的操作将一直处理,直到队列为空或发生不可恢复的错误。

清除队列

从文档处理队列中移除所有待处理的 URL。当您想重新开始、移除不需要的 URL 或取消待处理处理时,可以使用此功能重置队列。此操作是即时且永久的 - 如果您希望稍后处理 URL,则需要重新添加。

用法

RAG 文档工具旨在用于:

  • 利用相关文档增强人工智能响应
  • 构建具有文档意识的人工智能助手
  • 为开发人员创建上下文感知工具
  • 实现语义文档搜索
  • 扩充现有知识库

配置

与 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 密钥

执照

此 MCP 服务器采用 MIT 许可证。这意味着您可以自由使用、修改和分发该软件,但须遵守 MIT 许可证的条款和条件。更多详情,请参阅项目仓库中的 LICENSE 文件。

致谢

该项目是qpd-v/mcp-ragdocs的一个分支,最初由 qpd-v 开发。原始项目为本实现提供了基础。

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

MCP 服务器实现,提供通过矢量搜索检索和处理文档的工具,使 AI 助手能够利用相关文档上下文来增强其响应

  1. Features
    1. Tools
      1. search_documentation
      2. list_sources
      3. extract_urls
      4. remove_documentation
      5. list_queue
      6. run_queue
      7. clear_queue
    2. Usage
      1. Configuration
        1. Usage with Claude Desktop
      2. License
        1. Acknowledgments
          ID: 54hsrjhmq9