RustRAG

![License: MIT/Apache-2.0](LICENSE-MIT) ![CI](https://github.com/Michaol/RustRAG/actions/workflows/ci.yml) ![Rust](https://www.rust-lang.org)

🇨🇳 中文文档

用Rust编写的高性能本地RAG（检索增强生成）MCP服务器。

40倍代币减少 --在本地索引您的代码库，只为AI助手检索最相关的上下文。

______________________________________________________________________

特性

7 MCP工具 --搜索、索引、列表文档、管理文档、frontmatter、搜索关系、构建字典
24种支持的格式 --代码（Rust、Go、Python、TypeScript、JavaScript）、Markdown、纯文本、结构化数据（JSON、YAML、TOML、CSV）、HTML、PDF、DOCX、电子表格（XLS、XLSX、XLSB、ODS）
向量搜索 --SQLite+SQLite-vec用于快速局部向量相似性搜索
代码智能 --Rust、Go、Python、TypeScript、JavaScript的树型AST解析
多语词典 --CJK↔英文符号映射提取
高并发性和稳定性 --异步无阻塞后台同步(Arc)具有强大的分页功能，可防止10k+文件的MCP stdio传输缓冲区限制（零EOF丢失）。
汽车模型下载 --自动下载 multilingual-e5-small ONNX型号
交叉平台的 --macOS（英特尔/ARM）、Linux（x64/ARM64）、Windows（x64）

快速开始

1.安装

从以下网址下载适用于您平台的最新发布包发布:

平台	包装示例
Windows x64	`rustrag-windows-x64.exe.zip`
macOS苹果硅	`rustrag-macos-apple-silicon.tar.gz`
Linux x64	`rustrag-linux-x64.tar.gz`
Linux ARM64	`rustrag-linux-arm64.tar.gz`

安装步骤：

视窗

# Extract to a permanent directory
Expand-Archive rustrag-windows-x64.zip -DestinationPath "$env:LOCALAPPDATA\RustRAG"

⚠️ 重要：保持 rustrag.exe 与随附目录位于同一目录中 .dll 文件（例如。， onnxruntime.dll).做不单独移动exe——ONNX运行时库必须保留在它旁边。

macOS

mkdir -p ~/rustrag && tar xzf rustrag-macos-apple-silicon.tar.gz -C ~/rustrag
chmod +x ~/rustrag/rustrag

Linux

mkdir -p ~/rustrag && tar xzf rustrag-linux-x64.tar.gz -C ~/rustrag
chmod +x ~/rustrag/rustrag

提取后，使用 绝对路径 到 rustrag 配置IDE MCP设置时使用二进制。

或者，您可以从源代码构建：

# Clone and build
git clone https://github.com/Michaol/RustRAG.git
cd RustRAG
cargo build --release

2.配置

创建一个 config.json 在项目根目录中（首次运行时自动生成默认值）：

{
  "document_patterns": ["./"],
  "exclude_patterns": ["**/node_modules/**", "**/target/**", "**/.git/**"],
  "file_extensions": [
    "md", "rs", "go", "py", "js", "ts", "jsx", "tsx",
    "txt", "log",
    "json", "yaml", "yml", "toml", "csv",
    "html", "htm",
    "pdf", "docx", "xls", "xlsx", "xlsb", "ods"
  ],
  "db_path": "./vectors.db",
  "chunk_size": 500,
  "search_top_k": 5,
  "compute": {
    "device": "auto",
    "fallback_to_cpu": true
  },
  "model": {
    "name": "multilingual-e5-small",
    "dimensions": 384,
    "batch_size": 32
  }
}

3.添加到MCP客户端

反重力IDE

添加到您的 mcp_config.json （设置→ MCP服务器）：

{
  "mcpServers": {
    "rustrag": {
      "command": "path/to/rustrag",
      "args": ["--config", "path/to/config.json"]
    }
  }
}

克劳德桌面/光标

添加到MCP客户端配置文件：

{
  "mcpServers": {
    "rustrag": {
      "command": "path/to/rustrag",
      "args": ["--config", "path/to/config.json"]
    }
  }
}

🌩️ 高级：远程安装、本地调用（SSH模式）

如果您的大量代码库、开发环境和模型权重驻留在远程高性能服务器（或本地NAS）上，而您在轻量级笔记本电脑上编码，则可以远程安装RustRAG 通过SSH无缝挂载由于MCP使用标准流（stdio），SSH可以轻松地将其传输到本地IDE！

身份验证要求（重要）： MCP客户端（如Cursor或Claude Desktop）在后台静默运行进程 无法提示您输入密码因此，必须配置非交互式登录：

🔑 选项1:SSH密钥（强烈推荐，本机跨平台）

在本地计算机上生成密钥对(ssh-keygen -t ed25519)并将其推到遥控器上(ssh-copy-id user@ip)用于安全、无密码的安装。本机适用于Windows、macOS和Linux。

🔓 选项2： sshpass （基于密码，仅限Linux/macOS）

如果必须使用密码，请替换 command 和 sshpass （例如。， args: ["-p", "YOUR_PASSWORD", "ssh", "user@ip", ...]). 备注: sshpass 在Linux和macOS上很容易获得（通过 brew install sshpass)，但在Windows上本机安装极其困难。Windows用户应严格遵守选项1。

配置示例（本机SSH设置）：

{
  "mcpServers": {
    "rustrag-remote": {
      "command": "ssh",
      "args": [
        "user@remote.server.ip", // Replace with your remote host
        "/absolute/path/to/rustrag", // Remote path to rustrag binary
        "--config",
        "/remote/project/config.json" // Remote path to config
      ]
    }
  }
}

此设置使您的本地AI助手能够即时洞察数百万行远程代码，而您的本地计算机上的CPU或内存占用绝对为零。

💻 高级：解锁本地GPU加速（CUDA/TensorRT）

为了尽量减少存储库占用空间，并确保任何平台（特别是苹果Silicon Mac或没有独立GPU的笔记本电脑）上所有用户的开箱即用兼容性，RustRAG默认为轻量级 仅CPU模式 (fallback_to_cpu: true).但是，如果您拥有专用的NVIDIA GPU（例如RTX 30/40系列）并希望获得微秒级的矢量搜索吞吐量，则可以轻松解锁TensorRT/CUDA加速：

下载官方GPU运行库

导航到 ONNX Runtime v1.25.1发布页面并下载相应的操作系统GPU包（约300+MB）：

窗户： 下载 onnxruntime-win-x64-gpu-1.25.1.zip
Linux： 下载 onnxruntime-linux-x64-gpu-1.25.1.tgz
macOS： Apple Silicon Mac在CPU上运行速度很快，支持CoreML。请勿下载英伟达软件包。

设置动态库

提取存档并删除所有 .dll （适用于Windows）或 .so （对于Linux）文件（例如。， onnxruntime.dll, libonnxruntime_providers_cuda.so)确切地说 进入您的同一目录 rustrag 后端可执行二进制文件.

启用自动检测

打开项目配置(config.json)并确保：

"compute": {
  "device": "auto", // <-- Will auto-seek TensorRT, then CUDA, DML/CoreML, etc.
  "fallback_to_cpu": true // <-- Safety net to quietly fallback to CPU if GPU dlls are missing
}

如果满足要求，启动时MCP日志将自信地宣布 🚀 ONNX Execution Provider Activated: [TensorRT] 或 [CUDA]. 此配置完全与您的执行文件夹隔离；它永远不会污染核心项目存储库！

CLI选项

标志	默认值	描述
`--config`, `-c`	`config.json`	配置文件的路径
`--log-level`	`info`	日志级别（跟踪/调试/信息/警告/错误）
`--skip-download`	false	跳过自动模型下载
`--skip-sync`	false	跳过初始文档同步
`--transport`	`stdio`	运输方式： `stdio` 或 `http`
`--port`	`8765`	HTTP端口（用于传输=`http`)
`--version`	--	显示版本并退出

MCP工具

工具	说明
`search`	使用可选目录/文件名过滤器的自然语言矢量搜索
`index`	使用逻辑AST分块和抽象对标记或代码文件进行索引
`manage_document`	从索引中删除文档或强制重新索引现有文档
`list_documents`	列出所有索引文档
`frontmatter`	将YAML frontmatter元数据添加或更新到markdown文件
`search_relations`	搜索代码关系（调用、导入、继承）
`build_dictionary`	提取CJK↔来自代码的英文术语映射

建筑

src/
├── lib.rs # Module exports
├── main.rs # CLI + startup sequence
├── config.rs # Configuration loading/validation
├── frontmatter.rs # YAML frontmatter operations
├── updater.rs # Version update checker (GitHub API)
├── db/ # SQLite + sqlite-vec vector database
│   ├── mod.rs # Schema + connection management
│   ├── models.rs # Data models
│   ├── documents.rs # Document CRUD operations
│   ├── search.rs # Vector similarity search
│   └── relations.rs # Code relationship queries
├── embedder/ # Text embedding engine
│   ├── mod.rs # Embedder trait
│   ├── onnx.rs # ONNX Runtime inference
│   ├── mock.rs # Mock embedder (testing)
│   ├── tokenizer.rs # BERT tokenizer wrapper
│   └── download.rs # Model auto-download
├── indexer/ # Document & code indexing
│   ├── core.rs # Differential sync engine
│   ├── markdown.rs # Markdown chunking
│   ├── text_parser.rs # Multi-format document extraction (PDF, DOCX, XLSX, etc.)
│   ├── code_parser.rs # Tree-sitter code parsing
│   ├── relations.rs # Code relationship extraction
│   ├── dictionary.rs # Multilingual dictionary
│   └── languages.rs # Language-specific TS queries
└── mcp/ # MCP protocol layer
    ├── server.rs # Server setup (stdio + HTTP transport)
    └── tools.rs # 7 tool handler implementations

支持的语言

语言	扩展	解析器
生锈	`.rs`	树锈
去吧	`.go`	树保姆走
python `.py`	树栖蟒蛇
TypeScript	`.ts` `.tsx`	树型字体
JavaScript	`.js` `.jsx`	树型javascript
Markdown	`.md`	下拉cmark

支持的文档格式

格式	扩展名	分析器/库
纯文本	`.txt`, `.log`	`fs::read_to_string`
JSON	`.json`	`serde_json`
YAML	`.yaml`, `.yml`	`serde_yaml`
汤姆	`.toml`	`toml`
CSV	`.csv`	`csv`
HTML	`.html`, `.htm`	`scraper`
PDF	`.pdf`	`lopdf`
Word	`.docx`	`docx-rs`
电子表格	`.xls`, `.xlsx`, `.xlsb`, `.ods`	`calamine`

从源头构建

先决条件： 锈蚀1.85+

cargo build --release

二进制文件将位于 target/release/rustrag （或 rustrag.exe 在Windows上）。

测试

# Run all tests
cargo test --all
# Run integration tests only
cargo test --test integration_test
# Lint
cargo clippy -- -D warnings

许可证

根据以下任一方式获得许可

由您选择。

Rust Rag

快速接入

详细介绍

RustRAG

最新版本（v2.4.3）

v2.4.2文件监视器修复

v2.4.1 sqlite-vec升级

v2.4.0多格式文档支持

v2.3.0安全与代码质量

v2.2.0架构重构

v2.1.0高级改进

v2.0.0从ONNX模型迁移

v1.3.7配置热重载

v1.3.6硬件加速更新

v1.2.0和v1.1.0性能和压缩更新

特性