mcp-RAG文档增强工具
提供通过向量搜索检索和处理文档的工具,使人工智能助手能够以其相关文档上下文来增强其响应。
MCP 服务配置
复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用
{
"mcpServers": {
"rag-docs": {
"args": [
"-y",
"@hannesrudolph/mcp-ragdocs"
],
"command": "npx",
"env": {
"OPENAI_API_KEY": "",
"QDRANT_API_KEY": "",
"QDRANT_URL": ""
}
}
}
}
该服务需要配置环境变量:OPENAI_API_KEY、QDRANT_API_KEY、QDRANT_URL
服务介绍
RAG 文档 MCP 服务器
一个MCP服务器实现,提供通过向量搜索检索和处理文档的工具,使AI助手能够用相关的文档上下文增强其响应。
功能
- 基于向量的文档搜索和检索
- 支持多个文档源
- 语义搜索能力
- 自动化文档处理
- 实时为大语言模型(LLMs)增加上下文
工具
search_documentation
使用自然语言查询搜索存储的文档。返回按相关性排序并带有上下文的匹配摘录。
输入:
query(字符串): 在文档中搜索的文本。可以是自然语言查询、特定术语或代码片段。limit(数字, 可选): 返回的最大结果数量(1-20, 默认: 5)。较高的限制提供了更全面的结果,但可能需要更长的时间来处理。
list_sources
列出系统中当前存储的所有文档源。返回所有索引文档的综合列表,包括来源URL、标题和最后更新时间。使用此功能来了解可用于搜索的文档有哪些,或者验证特定来源是否已被索引。
extract_urls
从给定网页中提取并分析所有URL。该工具会爬取指定网页,识别所有超链接,并可选择地将它们添加到处理队列中。
输入:
url(字符串): 要分析的网页的完整URL(必须包含协议,例如https://)。页面必须公开可访问。add_to_queue(布尔值, 可选): 如果为真,则自动将提取出的URL添加到处理队列中以备后续索引。在大型网站上谨慎使用,以免造成过多排队。
remove_documentation
通过其URL从系统中移除特定的文档源。移除是永久性的,并将影响未来的搜索结果。
输入:
urls(字符串数组): 要从数据库中删除的URL数组。每个URL必须与添加文档时使用的URL完全匹配。
list_queue
列出当前等待在文档处理队列中的所有URL。显示待处理的文档源,这些源将在调用run_queue时被处理。使用此功能来监控队列状态,验证URL是否正确添加,或检查处理积压情况。
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 向量数据库实例的 URLQDRANT_API_KEY: 用于验证 Qdrant 的 API 密钥
待办事项
- 使嵌入可配置,以便在 OpenAI 嵌入和本地 Ollama 之间选择以生成向量
许可证
此 MCP 服务器根据 MIT 许可证授权。这意味着您可以自由使用、修改和分发该软件,但需遵守 MIT 许可证的条款和条件。更多详情,请参阅项目仓库中的 LICENSE 文件。
致谢
该项目是 qpd-v/mcp-ragdocs 的一个分支,最初由 qpd-v 开发。原项目为此实现提供了基础。