RAG Documentation MCP Server

RAG Documentation MCP Server

site icon
2025.02.07 23
TypeScript文档检索AI 增强向量搜索文档管理开发效率内容生成
mcp-ragdocs 是一个 MCP 服务器实现,专注于通过向量搜索检索和处理文档,使 AI 助手能够通过相关文档上下文增强其响应。该服务提供了多种工具来管理文档源、搜索文档内容以及处理文档队列,适用于构建文档感知的 AI 助手和开发上下文感知工具。
View on GitHub

Overview

基本能力

产品定位

mcp-ragdocs 是一个专为 AI 助手设计的文档检索和处理服务,通过向量搜索技术提供相关文档上下文,增强 AI 的响应能力。

核心功能

  1. 文档搜索:通过向量搜索技术检索相关文档片段。
  2. 文档管理:支持添加、删除和列出文档源。
  3. 队列处理:管理文档处理队列,包括运行、清除和列出队列项。
  4. URL 提取:从文本中提取 URL 并检查是否已存在于文档中。
  5. 多格式支持:支持多种文档格式和来源。

适用场景

  • 增强 AI 助手的响应能力
  • 构建文档感知的 AI 助手
  • 开发上下文感知工具
  • 实现语义文档搜索
  • 扩展现有知识库

工具列表

  1. search_documentation:通过向量搜索文档,返回相关片段和来源信息。
  2. list_sources:列出所有可用的文档源及其元数据。
  3. extract_urls:从文本中提取 URL 并检查是否已存在于文档中。
  4. remove_documentation:删除特定源的文档。
  5. list_queue:列出处理队列中的所有项及其状态。
  6. run_queue:处理队列中的所有项,自动将新文档添加到向量存储中。
  7. clear_queue:清除处理队列中的所有项。
  8. add_documentation:将新文档添加到处理队列中。

常见问题解答

  • 服务器无法启动(端口冲突)
  • 使用 npx kill-port 3030 终止占用端口的进程。
  • 重启 MCP 服务器。
  • 使用 lsof -i :3030 检查其他占用端口的进程。
  • 如有需要,可在配置中更改默认端口。

使用教程

使用依赖

  1. 确保已安装 Docker 和 Docker Compose。
  2. 如需使用 OpenAI 作为备用嵌入提供者,需提供 OPENAI_API_KEY

安装教程

  1. 使用 Docker Compose 启动服务: bash docker-compose up -d
  2. 停止服务: bash docker-compose down

调试方式

  1. 访问 Web 界面:http://localhost:3030
  2. 在 Web 界面中:
  3. 实时监控队列状态。
  4. 管理文档源。
  5. 测试查询搜索接口。
  6. 检查系统状态和健康状态。

许可证

该项目遵循 Other 开源许可条款,请参阅 Other 了解完整条款。