mcp-rag-server - RAG MCP Server

mcp-rag-server - RAG MCP Server

site icon
2025.04.10 1
TypeScriptRAG文档检索知识库问答开发效率内容生成
mcp-rag-server 是一个基于 Model Context Protocol (MCP) 的服务器,提供 Retrieval Augmented Generation (RAG) 功能。它通过索引和检索文档内容,使大型语言模型 (LLMs) 能够基于用户提供的文档内容回答问题。该服务器支持多种文件格式,包括 .txt、.md、.json、.jsonl 和 .csv,并允许用户通过简单的命令进行文档索引、查询和管理。
View on GitHub

Overview

基本能力

产品定位

mcp-rag-server 是一个专为增强大型语言模型 (LLMs) 上下文理解能力而设计的 MCP 服务器。它通过 RAG 技术,使 LLMs 能够基于用户提供的文档内容生成更准确和相关的回答。

核心功能

  1. 文档索引:支持从目录或单个文件中索引文档,支持多种文件格式(.txt、.md、.json、.jsonl、.csv)。
  2. 文档查询:通过 RAG 技术检索索引文档中的相关内容。
  3. 文档管理:支持删除特定文档或清除整个索引。
  4. 文档列表:显示所有已索引文档的路径。

适用场景

  1. 知识库问答:基于企业内部文档或知识库回答员工或客户的问题。
  2. 研究辅助:帮助研究人员快速检索和分析大量文档中的相关信息。
  3. 内容生成:为内容创作者提供基于文档的上下文支持,生成更准确的内容。

工具列表

  • index_documents:索引文档或目录中的文档。
  • query_documents:查询索引文档以获取相关上下文。
  • remove_document:删除特定文档。
  • remove_all_documents:清除整个索引。
  • list_documents:列出所有已索引文档。

常见问题解答

  1. 如何配置环境变量?
  2. 环境变量可以通过系统级别设置或在 MCP 客户端配置中传递。
  3. 支持哪些文件格式?
  4. 支持 .txt、.md、.json、.jsonl 和 .csv 格式。
  5. 如何更改嵌入模型?
  6. 通过设置 EMBEDDING_MODEL 环境变量来指定使用的嵌入模型。

使用教程

使用依赖

  1. Node.js:确保已安装 Node.js(版本要求见 package.json)。
  2. npm:确保已安装 npm。

安装教程

  1. 克隆仓库bash git clone https://github.com/yourusername/mcp-rag-server.git cd mcp-rag-server
  2. 安装依赖bash npm install
  3. 构建项目bash npm run build
  4. 运行服务器bash npm start

调试方式

  1. 检查环境变量:确保所有必要的环境变量已正确设置。
  2. 测试索引功能:使用 index_documents 命令索引一些文档。
  3. 测试查询功能:使用 query_documents 命令查询索引文档。
  4. 查看日志:检查服务器日志以确认操作是否成功。

许可证

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