RAG Docs

🚀 MCP 文档检索服务器

MCP 文档检索服务器可帮助用户高效地管理和检索文档。它支持从指定 URL 添加文档到数据库，还能在存储的文档中进行搜索，为用户提供便捷的文档处理体验。

🚀 快速开始

若要快速开启 MCP 文档检索服务器的使用之旅，可参考以下步骤。

📦 安装指南

克隆仓库

git clone https://github.com/qpd-v/mcp-server-ragdocs.git
cd mcp-server-ragdocs

安装依赖项

npm install

构建项目

npm run build

⚙️ 配置指南

环境变量配置

Qdrant 服务配置

• QDRANT_URL（必需）：Qdrant 实例的 URL 地址
  • 本地运行时使用：http://localhost:6333
  • 使用云服务时：https://your-cluster-url.qdrant.tech
• QDRANT_API_KEY（必需，用于云服务）：你的 Qdrant 云 API 密钥

嵌入式模型配置

• EMBEDDING_PROVIDER（可选）：选择 'ollama'（默认）或 'openai'
• EMBEDDING_MODEL（可选）：
  • 使用 Ollama 时，默认为 'nomic-embed-text'
  • 使用 OpenAI 时，默认为 'text-embedding-3-small'
• OLLAMA_URL（可选）：Ollama 实例的 URL 地址（默认 http://localhost:11434）
• OPENAI_API_KEY（必需，若使用 OpenAI）：你的 OpenAI API 密钥

🛠️ 可用工具

1. add_documentation

   • 功能：从指定 URL 添加文档到 RAG 数据库
   • 参数：
     • url：要获取的文档 URL 地址

2. search_documentation

   • 功能：在存储的文档中进行搜索
   • 参数：
     • query：搜索查询内容
     • limit（可选）：返回结果的最大数量（默认 5）

3. list_sources

   • 功能：列出当前存储的所有文档来源
   • 参数：无

💻 使用示例

基础用法

在 Claude Desktop 或其他 MCP 兼容客户端中，可按以下方式使用：

1. 添加文档：

添加此文档：https://docs.example.com/api

2. 搜索文档：

搜索文档以获取关于身份验证的信息

3. 列出来源：

有哪些可用的文档来源？

🛠️ 开发指南

克隆仓库

git clone https://github.com/qpd-v/mcp-server-ragdocs.git
cd mcp-server-ragdocs

安装依赖项

npm install

构建项目

npm run build

本地运行

npm start

📄 许可证

本项目采用 MIT 许可证。

⚠️ 故障排除

常见问题

1. Qdrant 连接错误

错误：无法连接到 Qdrant 服务 http://localhost:6333

解决办法：

• 检查 Docker 是否在运行
• 确认 Qdrant 容器是否正常运行：docker ps | grep qdrant
• 尝试重启容器

2. Ollama 模型未找到

错误：模型 nomic-embed-text 未找到

解决办法：

• 运行：ollama pull nomic-embed-text
• 验证模型是否已安装：ollama list

3. 配置路径问题 解决办法：

• Windows 系统中，确保使用正确的路径分隔符（反斜杠）
• 检查 .env 文件中的变量是否正确设置

4. 端口冲突

错误：EADDRINUSE @localhost:5000

解决办法：

• 检查是否有其他程序占用 5000 端口
• 尝试更换为其他可用端口

🤝 贡献指南

提交代码

1. 创建功能分支：

git checkout -b feature/your-feature-name

2. 提交更改：

git add .
git commit -m "描述你所做的修改"
git push origin feature/your-feature-name

3. 创建 Pull Request 到主分支

问题报告

• 提交 ISSUE 前，请先搜索现有问题，避免重复提交
• 提供详细的错误信息和复现步骤

感谢使用 MCP 文档检索服务器！如需更多信息，请访问我们的 GitHub 仓库。