Rag Server MCP

🚀 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 文件中設置：

💻 使用示例

基礎用法

開發環境搭建

1. 先決條件：需要安裝 Node.js (LTS 版本) 和 npm。
2. 安裝依賴：

npm install

3. 構建項目：

npm run build

4. 運行檢查器/格式化工具：
   • 代碼檢查：

npm run lint

- **代碼格式化**：

npm run format

- **全面驗證 (包括格式檢查、代碼檢查和類型檢查)**：

npm run validate

5. 運行測試：
   • 單元測試：

npm test

- **帶覆蓋的單元測試**：

npm run test:cov

6. 本地運行服務器 (無需 Docker)：
   • 確保 ChromaDB 和 Ollama 已經在運行並且可訪問。
   • 設置環境變量 (CHROMA_URL, OLLAMA_HOST)。
   • 執行：

npm start

📚 詳細文檔

完整的文檔將在 [TODO: 添加指向部署的 VitePress 站點鏈接]。

🔮 未來計劃

• 改進代碼文件切片策略。
• 支持更多文件類型（例如 PDF）。
• 提升查詢過濾能力。
• 調查並修復端到端測試中的失敗問題。
• 增強錯誤處理機制。

🤝 貢獻

歡迎貢獻！請在提交拉取請求之前，通過問題討論更改。遵循編碼標準和提交規範。

📄 許可證

本項目使用 MIT License 許可證。