mcp-rag-server

mcp-rag-server

支持检索增强生成（RAG）的模型上下文协议（MCP）服务。它会为你的文档建立索引，并通过 MCP 协议向大模型提供相关上下文。

集成示例

通用 MCP 客户端配置

{
  "mcpServers": {
    "rag": {
      "command": "npx",
      "args": ["-y", "mcp-rag-server"],
      "env": {
        "BASE_LLM_API": "http://localhost:11434/v1",
        "EMBEDDING_MODEL": "nomic-embed-text",
        "VECTOR_STORE_PATH": "./vector_store",
        "CHUNK_SIZE": "500"
      }
    }
  }
}

交互示例

# Index documents
>> tool:embedding_documents {"path":"./docs"}

# Check status
>> resource:embedding-status

<< rag://embedding/status
Current Path: ./docs/file1.md
Completed: 10
Failed: 0
Total chunks: 15
Failed Reason:

目录

• 集成示例
• 功能特性
• 安装
• 快速开始
• 配置
• 用法
  • MCP 工具
  • MCP 资源
• RAG 的工作原理
• 开发
• 贡献
• 许可证

功能特性

• 为 .txt、.md、.json、.jsonl 和 .csv 格式的文档建立索引
• 可自定义文本分块大小
• 使用 SQLite 提供本地向量存储（通过 LangChain 的 LibSQLVectorStore）
• 支持多种嵌入提供商（OpenAI、Ollama、Granite、Nomic）
• 通过 stdio 提供 MCP 工具和资源，轻松集成 MCP 客户端

安装

从 npm 安装

npm install -g mcp-rag-server

从源码安装

git clone https://github.com/kwanLeeFrmVi/mcp-rag-server.git
cd mcp-rag-server
npm install
npm run build
npm start

快速开始

export BASE_LLM_API=http://localhost:11434/v1
export EMBEDDING_MODEL=granite-embedding-278m-multilingual-Q6_K-1743674737397:latest
export VECTOR_STORE_PATH=./vector_store
export CHUNK_SIZE=500

# Run (global install)
mcp-rag-server

# Or via npx
npx mcp-rag-server

💡 提示： 建议使用 Ollama 生成嵌入。安装并拉取 nomic-embed-text 模型：

ollama pull nomic-embed-text
export EMBEDDING_MODEL=nomic-embed-text

配置

变量	描述	默认值
BASE_LLM_API	嵌入 API 的基础 URL	http://localhost:11434/v1
LLM_API_KEY	大模型提供商的 API 密钥	（空）
EMBEDDING_MODEL	嵌入模型标识符	nomic-embed-text
VECTOR_STORE_PATH	本地向量存储目录	./vector_store
CHUNK_SIZE	每个文本块的字符数（数字）	500

💡 建议： 为获得最佳性能，请使用 nomic-embed-text 等 Ollama 嵌入模型。

用法

MCP 工具

启动后，该服务会通过 MCP 提供以下工具：

• embedding_documents(path: string)：为指定路径下的文档建立索引
• query_documents(query: string, k?: number)：检索排名最高的 k 个文本块（默认值为 15）
• remove_document(path: string)：移除指定文档
• remove_all_documents(confirm: boolean)：清除整个索引（confirm=true）
• list_documents()：列出所有已建立索引的文档路径

MCP 资源

客户端还可以通过 URI 读取资源：

• rag://documents — 列出所有文档 URI
• rag://document/{path} — 获取文档的完整内容
• rag://query-document/{numberOfChunks}/{query} — 以资源形式查询文档
• rag://embedding/status — 查看当前索引状态（已完成、失败、总数）

RAG 的工作原理

1. 建立索引： 读取文件，根据 CHUNK_SIZE 将文本切分为多个文本块，并将其加入嵌入处理队列。
2. 生成嵌入： 逐个处理每个文本块并调用嵌入 API，将向量存储在 SQLite 中。
3. 查询： 为查询生成嵌入，从向量存储中检索最相近的文本块，并将其返回给客户端。

开发

npm install
npm run build      # Compile TypeScript
npm start          # Run server
npm run watch      # Watch for changes

贡献

欢迎贡献！请在 GitHub 上提交问题或拉取请求。

许可证

MIT 2025 Quan Le