Local RAG for developers using MCP. Semantic search with keyword boost for exact technical terms — fully private, zero setup.
-
Semantic search with keyword boost Vector search first, then keyword matching boosts exact matches. Terms like
useEffect, error codes, and class names rank higher—not just semantically guessed. -
Smart semantic chunking Chunks documents by meaning, not character count. Uses embedding similarity to find natural topic boundaries—keeping related content together and splitting where topics change.
-
Quality-first result filtering Groups results by relevance gaps instead of arbitrary top-K cutoffs. Get fewer but more trustworthy chunks.
-
Runs entirely locally No API keys, no cloud, no data leaving your machine. Works fully offline after the first model download.
-
Zero-friction setup One
npxcommand. No Docker, no Python, no servers to manage. Designed for Cursor, Codex, and Claude Code via MCP.
Set BASE_DIR to the folder you want to search. Documents must live under it.
Add the MCP server to your AI coding tool:
For Cursor — Add to ~/.cursor/mcp.json:
{
"mcpServers": {
"local-rag": {
"command": "npx",
"args": ["-y", "mcp-local-rag"],
"env": {
"BASE_DIR": "/path/to/your/documents"
}
}
}
}For Codex — Add to ~/.codex/config.toml:
[mcp_servers.local-rag]
command = "npx"
args = ["-y", "mcp-local-rag"]
[mcp_servers.local-rag.env]
BASE_DIR = "/path/to/your/documents"For Claude Code — Run this command:
claude mcp add local-rag --scope user --env BASE_DIR=/path/to/your/documents -- npx -y mcp-local-ragRestart your tool, then start using it:
You: "Ingest api-spec.pdf"
Assistant: Successfully ingested api-spec.pdf (47 chunks created)
You: "What does the API documentation say about authentication?"
Assistant: Based on the documentation, authentication uses OAuth 2.0 with JWT tokens.
The flow is described in section 3.2...
That's it. No installation, no Docker, no complex setup.
You want AI to search your documents—technical specs, research papers, internal docs. But most solutions send your files to external APIs.
Privacy. Your documents might contain sensitive data. This runs entirely locally.
Cost. External embedding APIs charge per use. This is free after the initial model download.
Offline. Works without internet after setup.
Code search. Pure semantic search misses exact terms like useEffect or ERR_CONNECTION_REFUSED. Keyword boost catches both meaning and exact matches.
The server provides 5 MCP tools: ingest, search, list, delete, status
(ingest_file, query_documents, list_files, delete_file, status).
"Ingest the document at /Users/me/docs/api-spec.pdf"
Supports PDF, DOCX, TXT, and Markdown. The server extracts text, splits it into chunks, generates embeddings locally, and stores everything in a local vector database.
Re-ingesting the same file replaces the old version automatically.
"What does the API documentation say about authentication?"
"Find information about rate limiting"
"Search for error handling best practices"
Search uses semantic similarity with keyword boost. This means useEffect finds documents containing that exact term, not just semantically similar React concepts.
Results include text content, source file, and relevance score. Adjust result count with limit (1-20, default 10).
"List all ingested files" # See what's indexed
"Delete old-spec.pdf from RAG" # Remove a file
"Show RAG server status" # Check system health
Adjust these for your use case:
| Variable | Default | Description |
|---|---|---|
RAG_HYBRID_WEIGHT |
0.6 |
Keyword boost factor. 0 = semantic only, higher = stronger keyword boost. |
RAG_GROUPING |
(not set) | similar for top group only, related for top 2 groups. |
RAG_MAX_DISTANCE |
(not set) | Filter out low-relevance results (e.g., 0.5). |
For codebases and API specs, increase keyword boost so exact identifiers (useEffect, ERR_*, class names) dominate ranking:
"env": {
"RAG_HYBRID_WEIGHT": "0.7",
"RAG_GROUPING": "similar"
}0.7— balanced semantic + keyword1.0— aggressive; exact matches strongly rerank results
Keyword boost is applied after semantic filtering, so it improves precision without surfacing unrelated matches.
TL;DR:
- Documents are chunked by semantic similarity, not fixed character counts
- Each chunk is embedded locally using Transformers.js
- Search uses semantic similarity with keyword boost for exact matches
- Results are filtered based on relevance gaps, not raw scores
When you ingest a document, the parser extracts text based on file type (PDF via pdfjs-dist, DOCX via mammoth, text files directly).
The semantic chunker splits text into sentences, then groups them using embedding similarity. It finds natural topic boundaries where the meaning shifts—keeping related content together instead of cutting at arbitrary character limits. This produces chunks that are coherent units of meaning, typically 500-1000 characters. Markdown code blocks are kept intact—never split mid-block—preserving copy-pastable code in search results.
Each chunk goes through a Transformers.js embedding model (default: all-MiniLM-L6-v2, configurable via MODEL_NAME), converting text into vectors. Vectors are stored in LanceDB, a file-based vector database requiring no server process.
When you search:
- Your query becomes a vector using the same model
- Semantic (vector) search finds the most relevant chunks
- Quality filters apply (distance threshold, grouping)
- Keyword matches boost rankings for exact term matching
The keyword boost ensures exact terms like useEffect or error codes rank higher when they match.
Configuration
| Variable | Default | Description |
|---|---|---|
BASE_DIR |
Current directory | Document root directory (security boundary) |
DB_PATH |
./lancedb/ |
Vector database location |
CACHE_DIR |
./models/ |
Model cache directory |
MODEL_NAME |
Xenova/all-MiniLM-L6-v2 |
HuggingFace model ID (available models) |
MAX_FILE_SIZE |
104857600 (100MB) |
Maximum file size in bytes |
Model choice tips:
- Multilingual docs → e.g.,
onnx-community/embeddinggemma-300m-ONNX(100+ languages) - Scientific papers → e.g.,
sentence-transformers/allenai-specter(citation-aware) - Code repositories → default often suffices; keyword boost matters more (or
jinaai/jina-embeddings-v2-base-code)
MODEL_NAME changes embedding dimensions. Delete DB_PATH and re-ingest after switching models.
Cursor — Global: ~/.cursor/mcp.json, Project: .cursor/mcp.json
{
"mcpServers": {
"local-rag": {
"command": "npx",
"args": ["-y", "mcp-local-rag"],
"env": {
"BASE_DIR": "/path/to/your/documents"
}
}
}
}Codex — ~/.codex/config.toml (note: must use mcp_servers with underscore)
[mcp_servers.local-rag]
command = "npx"
args = ["-y", "mcp-local-rag"]
[mcp_servers.local-rag.env]
BASE_DIR = "/path/to/your/documents"Claude Code:
claude mcp add local-rag --scope user \
--env BASE_DIR=/path/to/your/documents \
-- npx -y mcp-local-ragThe embedding model (~90MB) downloads on first use. Takes 1-2 minutes, then works offline.
- Path restriction: Only files within
BASE_DIRare accessible - Local only: No network requests after model download
- Model source: Official HuggingFace repository (verify here)
Performance
Tested on MacBook Pro M1 (16GB RAM), Node.js 22:
Query Speed: ~1.2 seconds for 10,000 chunks (p90 < 3s)
Ingestion (10MB PDF):
- PDF parsing: ~8s
- Chunking: ~2s
- Embedding: ~30s
- DB insertion: ~5s
Memory: ~200MB idle, ~800MB peak (50MB file ingestion)
Concurrency: Handles 5 parallel queries without degradation.
Troubleshooting
Documents must be ingested first. Run "List all ingested files" to verify.
Check internet connection. If behind a proxy, configure network settings. The model can also be downloaded manually.
Default limit is 100MB. Split large files or increase MAX_FILE_SIZE.
Check chunk count with status. Large documents with many chunks may slow queries. Consider splitting very large files.
Ensure file paths are within BASE_DIR. Use absolute paths.
- Verify config file syntax
- Restart client completely (Cmd+Q on Mac for Cursor)
- Test directly:
npx mcp-local-ragshould run without errors
FAQ
Is this really private? Yes. After model download, nothing leaves your machine. Verify with network monitoring.
Can I use this offline? Yes, after the first model download (~90MB).
How does this compare to cloud RAG? Cloud services offer better accuracy at scale but require sending data externally. This trades some accuracy for complete privacy and zero runtime cost.
What file formats are supported? PDF, DOCX, TXT, Markdown. Not yet: Excel, PowerPoint, images, HTML.
Can I change the embedding model? Yes, but you must delete your database and re-ingest all documents. Different models produce incompatible vector dimensions.
GPU acceleration? Transformers.js runs on CPU. GPU support is experimental. CPU performance is adequate for most use cases.
Multi-user support? No. Designed for single-user, local access. Multi-user would require authentication/access control.
How to backup?
Copy DB_PATH directory (default: ./lancedb/).
Development
git clone https://github.com/shinpr/mcp-local-rag.git
cd mcp-local-rag
pnpm installpnpm test # Run all tests
pnpm run test:watch # Watch modepnpm run type-check # TypeScript check
pnpm run check:fix # Lint and format
pnpm run check:deps # Circular dependency check
pnpm run check:all # Full quality checksrc/
index.ts # Entry point
server/ # MCP tool handlers
parser/ # PDF, DOCX, TXT, MD parsing
chunker/ # Text splitting
embedder/ # Transformers.js embeddings
vectordb/ # LanceDB operations
__tests__/ # Test suites
Contributions welcome. Before submitting a PR:
- Run tests:
pnpm test - Check quality:
pnpm run check:all - Add tests for new features
- Update docs if behavior changes
MIT License. Free for personal and commercial use.
Built with Model Context Protocol by Anthropic, LanceDB, and Transformers.js.