🚀 MCP RAG 服务器
MCP RAG 服务器 是一款基于 Model Context Protocol (MCP) 和 Retrieval Augmented Generation (RAG) 的工具。它借助与 ChromaDB 和 Ollama 的集成，为用户带来检索增强的生成体验。
✨ 主要特性
- 自动索引：服务器启动时，会自动对指定文件进行索引。
- 过滤支持：支持依据通配符模式排除特定文件或目录。
- 集成开发环境 (IDE) 插件：支持 VS Code 等 IDE 的插件，可直接在代码中使用 MCP 服务。
🚀 快速开始
安装依赖
npm install
构建项目
npm run build
启动服务器
npm start
配置 MCP 客户端
在 VS Code 等 IDE 的设置中，将 MCP 服务指向运行中的 RAG 服务器。
📦 安装指南
配置
通过环境变量进行配置，通常在 docker-compose.yml 文件中设置：
| 属性 | 详情 |
|---|---|
| CHROMA_URL | ChromaDB 服务的 URL，默认为 http://chromadb:8000 |
| OLLAMA_HOST | Ollama 服务的 URL，默认为 http://ollama:11434 |
| INDEX_PROJECT_ON_STARTUP | 设置为 true 或 false 来启用/禁用启动时自动索引，默认启用。 |
| INDEXING_EXCLUDE_PATTERNS | 逗号分隔的 glob 模式列表，用于排除特定文件或目录，默认包括 **/node_modules/** 和 **/.git/** |
💻 使用示例
基础用法
开发环境搭建
- 先决条件：需要安装 Node.js (LTS 版本) 和 npm。
- 安装依赖：
npm install
- 构建项目：
npm run build
- 运行检查器/格式化工具：
- 代码检查：
npm run lint
- **代码格式化**：
npm run format
- **全面验证 (包括格式检查、代码检查和类型检查)**：
npm run validate
- 运行测试：
- 单元测试：
npm test
- **带覆盖的单元测试**：
npm run test:cov
- 本地运行服务器 (无需 Docker)：
- 确保 ChromaDB 和 Ollama 已经在运行并且可访问。
- 设置环境变量 (
CHROMA_URL,OLLAMA_HOST)。 - 执行：
npm start
📚 详细文档
完整的文档将在 [TODO: 添加指向部署的 VitePress 站点链接]。
🔮 未来计划
- 改进代码文件切片策略。
- 支持更多文件类型（例如 PDF）。
- 提升查询过滤能力。
- 调查并修复端到端测试中的失败问题。
- 增强错误处理机制。
🤝 贡献
欢迎贡献！请在提交拉取请求之前，通过问题讨论更改。遵循编码标准和提交规范。
📄 许可证
本项目使用 MIT License 许可证。