
RAG Documentation MCP Server

2024.12.17
143
TypeScript文档检索AI增强语义搜索上下文增强开发效率内容生成
RAG Documentation MCP Server 是一个基于向量搜索的文档检索和处理服务,旨在为AI助手提供相关文档上下文,增强其回答能力。该服务支持多种文档来源,具备语义搜索能力,并能实时为大型语言模型(LLM)提供上下文增强。
View on GitHub
Overview
基本能力
产品定位
RAG Documentation MCP Server 是一个专为AI助手和开发者设计的文档检索和处理服务,通过向量搜索技术提供相关文档上下文,增强AI回答的准确性和丰富性。
核心功能
- 向量搜索与检索:基于向量的文档搜索和检索功能。
- 多文档源支持:支持多种文档来源的索引和处理。
- 语义搜索:具备语义搜索能力,能够理解自然语言查询。
- 自动化文档处理:自动处理文档并将其添加到索引中。
- 实时上下文增强:为LLM提供实时文档上下文。
适用场景
- 增强AI助手的回答能力。
- 构建基于文档的AI助手。
- 开发上下文感知的开发工具。
- 实现语义文档搜索。
- 扩展现有知识库。
工具列表
- search_documentation:通过自然语言查询搜索文档,返回相关片段。
- 输入:
query
(搜索文本),limit
(可选,结果数量)。 - list_sources:列出所有已索引的文档来源。
- extract_urls:从网页提取URL并分析。
- 输入:
url
(网页URL),add_to_queue
(可选,是否添加到队列)。 - remove_documentation:从系统中删除指定文档来源。
- 输入:
urls
(要删除的URL数组)。 - list_queue:列出文档处理队列中的所有URL。
- run_queue:处理并索引队列中的所有URL。
- clear_queue:清除文档处理队列中的所有URL。
常见问题解答
- 如何配置环境变量?:需提供
OPENAI_API_KEY
、QDRANT_URL
和QDRANT_API_KEY
。 - 如何添加文档来源?:使用
extract_urls
工具并设置add_to_queue
为true
。 - 如何删除文档?:使用
remove_documentation
工具指定URL数组。
使用教程
使用依赖
- 确保已安装Node.js和npm。
- 获取OpenAI API密钥和Qdrant数据库的URL及API密钥。
安装教程
- 在
claude_desktop_config.json
中添加以下配置:json { "mcpServers": { "rag-docs": { "command": "npx", "args": [ "-y", "@hannesrudolph/mcp-ragdocs" ], "env": { "OPENAI_API_KEY": "your_openai_api_key", "QDRANT_URL": "your_qdrant_url", "QDRANT_API_KEY": "your_qdrant_api_key" } } } }
- 替换
your_openai_api_key
、your_qdrant_url
和your_qdrant_api_key
为实际值。
调试方式
- 启动服务后,使用
list_sources
工具检查文档来源是否已正确索引。 - 使用
search_documentation
工具测试搜索功能是否正常。 - 使用
list_queue
和run_queue
工具检查文档处理队列的状态。