io.github.RobThePCGuy/rag-vault

Official

by RobThePCGuy · TypeScript

Local RAG MCP server with hybrid search, PDF/DOCX support, and zero-config setup

Local RAG system with hybrid search supporting PDFs and DOCX files.

Topics

claude-codecodexcursordocument-searchembeddingslancedblocal-aimcpmcp-servermodel-context-protocolprivacyragsemantic-searchtransformers-jstypescriptvector-search

README.md23 KBView on GitHub

RAG Vault

Your documents. Your machine. Your control.

RAG Vault lets your AI coding assistant search your private documents, things like API specs, research papers, and internal docs. Everything runs locally and your data stays on your machine unless you choose to pull in content from a remote URL.

One command to run, minimal setup, privacy by default.

Why RAG Vault?

Pain Point	RAG Vault Solution
"I don't want my docs on someone else's server"	Everything stays local by default. No background cloud calls for indexing or search.
"Semantic search misses exact code terms"	Hybrid search with RRF fusion, optional cross-encoder reranking
"Setup requires Docker, Python, databases..."	One `npx` command plus a small MCP config block.
"Cloud APIs charge per query"	Free forever. No subscriptions.

Security

RAG Vault comes with security built in:

API Authentication: Optional API key via RAG_API_KEY
Rate Limiting: You can throttle requests
CORS Control: Restrict allowed origins
Security Headers: Helmet.js protection

See SECURITY.md for complete documentation.

First-Time Setup Checklist

Before adding MCP config:

Install Node.js 20 or newer.
Pick a documents directory and set BASE_DIR to that path.
Make sure your AI tool process can read BASE_DIR.
Restart your AI tool after editing config.

Get Started Quickly

For Cursor

Add to ~/.cursor/mcp.json:

json

{
  "mcpServers": {
    "local-rag": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "github:RobThePCGuy/rag-vault"],
      "env": {
        "BASE_DIR": "/path/to/your/documents"
      }
    }
  }
}

Replace /path/to/your/documents with your real absolute path.

For Claude Code

Add to .mcp.json in your project directory:

json

{
  "mcpServers": {
    "local-rag": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "github:RobThePCGuy/rag-vault"],
      "env": {
        "BASE_DIR": "./documents",
        "DB_PATH": "./documents/.rag-db",
        "CACHE_DIR": "./.cache",
        "RAG_EMBEDDING_DEVICE": "cpu",
        "RAG_HYBRID_WEIGHT": "0.6",
        "RAG_GROUPING": "related"
      }
    }
  }
}

Or add inline via CLI:

bash

claude mcp add local-rag --scope user --env BASE_DIR=/path/to/your/documents -- npx -y github:RobThePCGuy/rag-vault

For Codex

Add to ~/.codex/config.toml:

toml

[mcp_servers.local-rag]
command = "npx"
args = ["-y", "github:RobThePCGuy/rag-vault"]

[mcp_servers.local-rag.env]
BASE_DIR = "/path/to/your/documents"

Install Skills (Optional)

If you want your AI to write better queries and make more sense of results, install the RAG Vault skills:

bash

# Claude Code (project-level - recommended for team projects)
npx github:RobThePCGuy/rag-vault skills install --claude-code

# Claude Code (user-level - available in all projects)
npx github:RobThePCGuy/rag-vault skills install --claude-code --global

# Codex (user-level)
npx github:RobThePCGuy/rag-vault skills install --codex

# Custom location
npx github:RobThePCGuy/rag-vault skills install --path /your/custom/path

Skills teach Claude best practices for:

Query formulation and expansion strategies
Score interpretation. In boost mode, under 0.3 is a good match and over 0.5 is worth skipping. RRF mode scores by rank instead.
When to use ingest_file vs ingest_data
HTML ingestion and URL handling

Restart your AI tool, and start talking:

code

You: "Ingest api-spec.pdf"
AI:  Successfully ingested api-spec.pdf (47 chunks)

You: "How does authentication work?"
AI:  Based on section 3.2, authentication uses OAuth 2.0 with JWT tokens...

That's it. No Docker. No Python. No server infrastructure to manage.

Web Interface

RAG Vault has a web UI so you can manage your documents without touching the command line.

Launch the Web UI

bash

npx github:RobThePCGuy/rag-vault web

Open http://localhost:3000 in your browser.

What You Can Do

Upload documents: Drag and drop PDF, DOCX, Markdown, TXT, JSON, JSONL, and NDJSON files
Search instantly: Type queries and see results with relevance scores
Preview content: Click any result to see the full chunk in context
Manage files: View all indexed documents and delete what you don't need
Switch databases: Create and switch between multiple knowledge bases
Monitor status: See document counts, memory usage, and search mode
Export/Import settings: Back up and restore your vault configuration
Theme preferences: Switch between light, dark, or system theme
Folder browser: Navigate directories to select documents

REST API

The web server has a REST API you can hit directly. Set RAG_API_KEY to require authentication:

bash

# With authentication (when RAG_API_KEY is set)
curl -X POST "http://localhost:3000/api/v1/search" \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"query": "authentication", "limit": 5}'

# Search documents (no auth needed if RAG_API_KEY isn't set)
curl -X POST "http://localhost:3000/api/v1/search" \
  -H "Content-Type: application/json" \
  -d '{"query": "authentication", "limit": 5}'

# List all files
curl "http://localhost:3000/api/v1/files"

# Upload a document
curl -X POST "http://localhost:3000/api/v1/files/upload" \
  -F "file=@spec.pdf"

# Delete a file
curl -X DELETE "http://localhost:3000/api/v1/files" \
  -H "Content-Type: application/json" \
  -d '{"filePath": "/path/to/spec.pdf"}'

# Get system status
curl "http://localhost:3000/api/v1/status"

# Health check (for load balancers)
curl "http://localhost:3000/api/v1/health"

Reader API Endpoints

These endpoints let you read documents and find connections across them:

bash

# Get all chunks for a document (ordered by index)
curl "http://localhost:3000/api/v1/documents/chunks?filePath=/path/to/doc.pdf"

# Find related chunks for cross-document discovery
curl "http://localhost:3000/api/v1/chunks/related?filePath=/path/to/doc.pdf&chunkIndex=0&limit=5"

# Batch request for multiple chunks (efficient for UIs)
curl -X POST "http://localhost:3000/api/v1/chunks/batch-related" \
  -H "Content-Type: application/json" \
  -d '{"chunks": [{"filePath": "/path/to/doc.pdf", "chunkIndex": 0}], "limit": 3}'

Remote Mode

RAG Vault can also run as an HTTP server so remote MCP clients like Claude.ai, Claude Desktop, or anything that supports Streamable HTTP or SSE can connect to it.

bash

# Start remote server (default port 3001)
npx github:RobThePCGuy/rag-vault --remote

# Custom port
npx github:RobThePCGuy/rag-vault --remote --port 8080

Stdio mode is unchanged. Just leave off --remote and everything works as before with Cursor, Claude Code, and Codex.

Connecting from Claude Desktop

Add to your Claude Desktop config:

json

{
  "mcpServers": {
    "rag-vault-remote": {
      "type": "url",
      "url": "http://localhost:3001/mcp"
    }
  }
}

Or via Claude Code CLI:

bash

claude mcp add --transport http rag-vault http://localhost:3001/mcp

Connecting from Claude.ai

For Claude.ai (Pro/Max/Team/Enterprise), add as a custom connector with URL https://your-host:3001/mcp. For local development, expose your server with a tunnel:

bash

cloudflared tunnel --url http://localhost:3001

Set RAG_API_KEY for authentication when exposing remotely. The server supports both Streamable HTTP (/mcp) and legacy SSE (/sse) transports, plus a health check at /health.

Real-World Examples

Search Your Codebase Documentation

code

You: "Ingest all the markdown files in /docs"
AI:  Ingested 23 files (847 chunks total)

You: "What's the retry policy for failed API calls?"
AI:  According to error-handling.md, failed requests retry 3 times
     with exponential backoff: 1s, 2s, 4s...

Index Web Documentation

code

You: "Fetch https://docs.example.com/api and ingest the HTML"
AI:  Ingested "docs.example.com/api" (156 chunks)

You: "What rate limits apply to the /users endpoint?"
AI:  The API limits /users to 100 requests per minute per API key...

Build a Personal Knowledge Base

code

You: "Ingest my research papers folder"
AI:  Ingested 12 PDFs (2,341 chunks)

You: "What do recent studies say about transformer attention mechanisms?"
AI:  Based on attention-mechanisms-2024.pdf, the key finding is...

Search Exact Technical Terms

RAG Vault's hybrid search catches both meaning and exact matches:

code

You: "Search for ERR_CONNECTION_REFUSED"
AI:  Found 3 results mentioning ERR_CONNECTION_REFUSED:
     1. troubleshooting.md - "When you see ERR_CONNECTION_REFUSED..."
     2. network-errors.pdf - "Common causes include..."

Pure semantic search would miss this. RAG Vault finds it.

How It Works

code

Document → Parse → Chunk by meaning → Embed locally → Store in LanceDB
                         ↓
Query → Embed → Vector search + BM25 → Fusion → Optional reranking → Results

Smart chunking: Splits by meaning, not character count. Keeps code blocks intact.

Hybrid search: Two fusion modes that combine vector similarity with BM25 keyword matching:

Boost mode (default): BM25 boosts vector search distances multiplicatively. Simple and predictable.
RRF mode (opt-in via RAG_SEARCH_MODE=rrf): Reciprocal Rank Fusion treats vector and BM25 as independent voters. This can surface documents that vector search alone would miss.

Cross-encoder reranking (opt-in): After the first pass, a cross-encoder model (Xenova/ms-marco-MiniLM-L-6-v2, ~23MB) scores each (query, passage) pair together for tighter relevance ranking. Turn it on with RAG_RERANKER_ENABLED=true.

Query expansion (opt-in): Generates reformulated queries to improve recall when searches are paraphrased or conceptual. Two backends: local template-based expansion (default, fully offline) or LLM-based HyDE through an external API. Turn it on with RAG_HYDE_ENABLED=true.

Quality filtering: Groups results by relevance gaps instead of arbitrary top-K cutoffs.

Local by default: Embeddings via Transformers.js. Storage via LanceDB. Network is only needed for initial model download or if you explicitly ingest remote URLs.

MCP tools included: query_documents, ingest_file, ingest_data, delete_file, list_files, status, feedback_pin, feedback_dismiss, and feedback_stats.

Supported Formats

Format	Extension	Notes
PDF	`.pdf`	Full text extraction, header/footer filtering
Word	`.docx`	Tables, lists, formatting preserved
Markdown	`.md`	Code blocks kept intact
Text	`.txt`	Plain text
JSON	`.json`	Converted to searchable key-value text
JSONL / NDJSON	`.jsonl`, `.ndjson`	Parsed line-by-line for logs and structured records
HTML	via `ingest_data`	Auto-cleaned with Readability

Configuration

Environment Variables

Variable	Default	What it does
`BASE_DIR`	Current directory	Only files under this path can be accessed
`DB_PATH`	`./lancedb/`	Where vectors are stored
`CACHE_DIR`	`./models/`	Model cache directory
`MODEL_NAME`	`Xenova/all-MiniLM-L6-v2`	HuggingFace embedding model
`MAX_FILE_SIZE`	`104857600` (100 MB)	Biggest file you can ingest
`RAG_EMBEDDING_DEVICE`	`auto`	Device for running embeddings: `auto`, `cpu`, `cuda`, `dml`, `webgpu`, `wasm`, `gpu`, `webnn`
`WEB_PORT`	`3000`	Port for web interface
`UPLOAD_DIR`	`./uploads/`	Temporary directory for web UI file uploads

Windows users: RAG_EMBEDDING_DEVICE=auto tries GPU providers (DirectML), which can fail if ONNX Runtime GPU binaries aren't available. If you see embedding initialization errors, set RAG_EMBEDDING_DEVICE=cpu in your MCP config for reliable operation. See the GPU acceleration FAQ for details.

One-command override (no .env edit):

bash

# MCP mode
npx github:RobThePCGuy/rag-vault --embedding-device cpu

# Web mode
npx github:RobThePCGuy/rag-vault web --embedding-device dml

# Explicitly force auto detection
npx github:RobThePCGuy/rag-vault --gpu-auto

Search Tuning

Variable	Default	What it does
`RAG_SEARCH_MODE`	`boost`	Fusion mode: `boost` (multiplicative keyword boost) or `rrf` (Reciprocal Rank Fusion)
`RAG_HYBRID_WEIGHT`	`0.6`	Balance between vector and BM25. `0` = vector-only, `1.0` = BM25-only
`RAG_RRF_K`	`60`	RRF smoothing constant (only applies in `rrf` mode). Industry standard is 60.
`RAG_GROUPING`	unset	Quality filter: `similar` = top group only, `related` = top 2 groups
`RAG_MAX_DISTANCE`	unset	Drops results below this relevance threshold (use with `boost` mode; `rrf` scores are rank-based)
`RAG_GROUPING_STD_MULTIPLIER`	`1.5`	How many standard deviations between groups counts as a relevance gap
`RAG_HYBRID_CANDIDATE_MULTIPLIER`	`2`	How many extra vector candidates to grab before keyword reranking
`RAG_FTS_MAX_FAILURES`	`3`	Full-text search failures before FTS is temporarily disabled
`RAG_FTS_COOLDOWN_MS`	`300000` (5 min)	How long to wait before retrying FTS after hitting the failure limit

Cross-Encoder Reranking (opt-in)

Variable	Default	What it does
`RAG_RERANKER_ENABLED`	`false`	Turn on cross-encoder reranking for better results
`RAG_RERANKER_MODEL`	`Xenova/ms-marco-MiniLM-L-6-v2`	HuggingFace cross-encoder model (~23MB ONNX, downloads on first use)
`RAG_RERANKER_CANDIDATE_MULTIPLIER`	`2`	Fetch this many extra candidates for the reranker to score
`RAG_RERANKER_DEVICE`	`auto`	Device for the reranker (same options as `RAG_EMBEDDING_DEVICE`)
`RERANKER_INIT_TIMEOUT_MS`	`600000` (10 min)	Timeout for model download and initialization

Query Expansion / HyDE (opt-in)

Variable	Default	What it does
`RAG_HYDE_ENABLED`	`false`	Turn on query expansion for better recall
`RAG_HYDE_BACKEND`	`rule-based`	`rule-based` for local template expansion, `api` for LLM-based HyDE
`RAG_HYDE_EXPANSIONS`	`2`	Number of expanded queries to generate
`RAG_HYDE_API_KEY`	unset	API key for LLM backend (required when `RAG_HYDE_BACKEND=api`)
`RAG_HYDE_API_BASE_URL`	`https://api.anthropic.com`	API endpoint for LLM backend
`RAG_HYDE_API_MODEL`	`claude-haiku-4-5-20251001`	Model for LLM-based expansion

Privacy note: The api backend sends query text to an external LLM endpoint, which breaks the "zero cloud" guarantee. The default rule-based backend is fully local.

Security (optional)

Variable	Default	What it does
`RAG_API_KEY`	unset	API key for authentication
`CORS_ORIGINS`	localhost	Allowed origins (comma-separated, or `*`)
`RATE_LIMIT_WINDOW_MS`	`60000`	Rate limit time window (ms)
`RATE_LIMIT_MAX_REQUESTS`	`100`	Max requests per window

Advanced

Variable	Default	What it does
`ALLOWED_SCAN_ROOTS`	Home directory	Directories allowed for database scanning
`JSON_BODY_LIMIT`	`5mb`	Max request body size
`REQUEST_TIMEOUT_MS`	`30000`	API request timeout
`REQUEST_LOGGING`	`false`	Turn on request audit logging

Copy .env.example for a complete configuration template.

For code-heavy content, try:

json

"env": {
  "RAG_HYBRID_WEIGHT": "0.8",
  "RAG_GROUPING": "similar"
}

Frequently Asked Questions

<details> <summary>Is my data really private?</summary>

For local files, yes. Indexing and search run on your machine after the embedding model downloads (~90MB). RAG Vault only hits the network if you choose remote URL ingestion or need to download a model.

</details> <details> <summary>Does it work offline?</summary>

Yes, after the first run. The model caches locally.

</details> <details> <summary>What about GPU acceleration?</summary>

RAG Vault picks a device automatically by default (RAG_EMBEDDING_DEVICE=auto). When GPU providers are set up correctly, this can speed up embedding generation.

Important: On Windows, auto tries DirectML (dml), which requires ONNX Runtime GPU binaries. If those binaries aren't installed or your GPU setup is incomplete, the server won't start at all. It doesn't fall back to CPU gracefully. The same goes for Linux without CUDA binaries.

Recommendation: If you hit embedding initialization errors, set RAG_EMBEDDING_DEVICE=cpu in your MCP config. CPU mode is reliable on all platforms and fast enough for most workloads (the default model is only ~90MB).

json

"env": {
  "RAG_EMBEDDING_DEVICE": "cpu"
}

Supported device values: auto, cpu, cuda, dml, gpu, wasm, webgpu, webnn, webnn-npu, webnn-gpu, webnn-cpu. The alias directml is also accepted and maps to dml.

</details> <details> <summary>Can I change the embedding model?</summary>

Yes. Set MODEL_NAME to any compatible HuggingFace model. You'll need to delete DB_PATH and re-ingest because different models produce incompatible vectors.

Recommended upgrade: For better quality and multilingual support, use EmbeddingGemma:

json

"MODEL_NAME": "onnx-community/embeddinggemma-300m-ONNX"

It's a solid pick if you need multilingual support or higher-quality retrieval.

Other specialized models:

Scientific: sentence-transformers/allenai-specter
Code: jinaai/jina-embeddings-v2-base-code

</details> <details> <summary>How do I back up my data?</summary>

Copy the DB_PATH directory (default: ./lancedb/).

</details>

Troubleshooting

Problem	Solution
No results found	Documents need to be ingested first. Run "List all ingested files" to check.
Model download failed	Check your internet connection. The model is ~90MB from HuggingFace.
Embedding initialization fails	Set `RAG_EMBEDDING_DEVICE=cpu` in your MCP config. The `auto` default can fail on Windows without GPU binaries.
`Protobuf parsing failed`	Corrupted model cache. Delete `CACHE_DIR` (default: `./models/`) and restart. RAG Vault also auto-retries with an isolated recovery cache.
File too large	Default limit is 100MB. Set `MAX_FILE_SIZE` higher or split the file.
Path outside BASE_DIR	All file paths must be under `BASE_DIR`. Use absolute paths.
MCP tools not showing	Check your config syntax and restart your AI tool completely (Cmd+Q on Mac).
`mcp-publisher login github` fails with `slow_down`	Use token login instead: `mcp-publisher login github --token "$(gh auth token)"` (or pass a PAT).
401 Unauthorized	API key required. Set `RAG_API_KEY` or use the correct header format.
429 Too Many Requests	Rate limited. Wait for the reset or increase `RATE_LIMIT_MAX_REQUESTS`.
CORS errors	Add your origin to `CORS_ORIGINS` environment variable.

Development

bash

git clone https://github.com/RobThePCGuy/rag-vault.git
cd rag-vault
pnpm install
pnpm --prefix web-ui install

# Install local git hooks (recommended, even for solo dev)
pnpm hooks:install

# Fast local quality gate (backend + web-ui type/lint/format, deps, unused, build, unit tests)
pnpm check:all

# Unit tests only (no model download required)
pnpm test:unit

# Integration/E2E tests (requires model download/network)
pnpm test:integration

# Build
pnpm build

# Run MCP server locally (stdio)
pnpm dev

# Run MCP server locally (remote HTTP + SSE)
pnpm dev:remote

# Run web server locally
pnpm web:dev

# Release to npm (local, guarded)
pnpm release          # patch
pnpm release:minor
pnpm release:major
pnpm release:dry

Test Tiers

pnpm test:unit: deterministic tests for local/CI quality checks. Doesn't include model-download integration paths.
pnpm test:integration: full integration and E2E workflows, including embedding model initialization.

Use RUN_EMBEDDING_INTEGRATION=1 to explicitly opt into network/model-dependent suites.

Release Strategy

Releases are local and scripted via scripts/release-npm.sh.
Supported bumps: patch, minor, major.
The script runs dependency installs, pnpm check:all, and pnpm ui:build before touching version files.
package.json and server.json versions only get updated after checks pass, and they're auto-restored if any later step fails.
pnpm release:dry runs the full gate plus npm dry-run publish and always restores version files.

Project Structure

code

src/
├── bin/             # CLI subcommands (skills install)
├── chunker/         # Semantic text splitting
├── embedder/        # Transformers.js wrapper
├── errors/          # Error handling utilities
├── explainability/  # Keyword-based result explanations
├── flywheel/        # Feedback loop (pin/dismiss reranking)
├── hyde/            # Query expansion + HyDE (LLM-based)
├── parser/          # PDF, DOCX, HTML parsing
├── query/           # Advanced query syntax parser
├── reranker/        # Cross-encoder reranking (Transformers.js)
├── server/          # MCP tool handlers + remote transport
├── utils/           # Config, file helpers, process handlers
├── vectordb/        # LanceDB + hybrid search (boost + RRF)
└── web/             # Express server + REST API

web-ui/              # React frontend (Vite + Tailwind)

Documentation

SECURITY.md: Security configuration and best practices
.env.example: Complete environment variable template

License

MIT: free for personal and commercial use.

Acknowledgments

Built with Model Context Protocol, LanceDB, and Transformers.js.

Started as a fork of mcp-local-rag by Shinsuke Kagawa. Now it's its own thing. Huge credit to upstream contributors for the foundation, I've been iterating hard from there. Local-first dev tools, all the way.

Install

Configuration

Environment variables

BASE_DIR

Base directory for document storage (defaults to current working directory)

DB_PATH

Path to LanceDB database directory (defaults to ./lancedb/)

CACHE_DIR

Directory where Transformers.js models are cached (defaults to ./models/)

MODEL_NAME

Embedding model name (defaults to Xenova/all-MiniLM-L6-v2)

RAG_HYBRID_WEIGHT

Keyword boost strength for hybrid search. 0.0 = semantic only, 1.0 = keyword only. Default 0.6

RAG_GROUPING

Grouping mode: 'similar' (top group only) or 'related' (top 2 groups)

claude_desktop_config.json

{
  "mcpServers": {
    "rag-vault": {
      "command": "npx",
      "args": [
        "-y",
        "@robthepcguy/rag-vault@1.5.3"
      ],
      "env": {
        "BASE_DIR": "<YOUR_BASE_DIR>",
        "DB_PATH": "<YOUR_DB_PATH>",
        "CACHE_DIR": "<YOUR_CACHE_DIR>",
        "MODEL_NAME": "<YOUR_MODEL_NAME>",
        "RAG_HYBRID_WEIGHT": "<YOUR_RAG_HYBRID_WEIGHT>",
        "RAG_GROUPING": "<YOUR_RAG_GROUPING>"
      }
    }
  }
}