npm - knowledge-rag - Versions diffs - 4.8.4 → 4.9.0 - Mend

knowledge-rag 4.8.4 → 4.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,33 @@
-# Knowledge RAG
+<!--
+knowledge-rag — Local RAG server for Claude Code, Cursor, Windsurf and other MCP clients.
+SEO keywords: local rag, mcp server, self-hosted rag, hybrid search, cross-encoder reranking, claude code rag, cursor rag, python rag, chromadb rag, fastembed rag, air-gapped rag, gdpr rag, retrieval augmented generation, model context protocol server, zero cloud rag.
+Structured data (schema.org SoftwareApplication) — indexed by search engines, invisible on GitHub render:
+{
+  "@context": "https://schema.org",
+  "@type": "SoftwareApplication",
+  "name": "knowledge-rag",
+  "applicationCategory": "DeveloperApplication",
+  "operatingSystem": "Windows, Linux, macOS",
+  "description": "Local-first RAG server for AI agents. Hybrid search, MCP-native, zero cloud, enterprise-grade plumbing (bearer auth, Prometheus metrics, rate limiting, health probes, structured JSON logging, zero-downtime reindex).",
+  "offers": { "@type": "Offer", "price": "0", "priceCurrency": "USD" },
+  "license": "https://opensource.org/licenses/MIT",
+  "downloadUrl": "https://pypi.org/project/knowledge-rag/",
+  "codeRepository": "https://github.com/lyonzin/knowledge-rag",
+  "programmingLanguage": "Python",
+  "runtimePlatform": "Python 3.11+"
+}
+-->
+<p align="center">
+  <img
+    src="./assets/knowledge-rag-banner.png"
+    alt="knowledge-rag — Local Hybrid RAG for MCP"
+    width="100%"
+  />
+</p>
+# knowledge-rag
 <div align="center">
@@ -15,32 +44,30 @@
 [![Glama Score](https://glama.ai/mcp/servers/lyonzin/knowledge-rag/badges/score.svg)](https://glama.ai/mcp/servers/lyonzin/knowledge-rag)
 [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/13864/badge)](https://bestpractices.coreinfrastructure.org/projects/13864)
-### Your docs, your machine, zero cloud. Claude Code searches them natively.
+### The MCP-first local RAG server for Claude Code, Cursor, and every AI agent.
-Drop your PDFs, markdown, code, notebooks — **1800+ files, 39K chunks, indexed in under 3 minutes.**<br/>
-Hybrid search (BM25 + semantic vectors + cross-encoder reranking) through 13 MCP tools.<br/>
-Everything runs locally via ONNX. No Docker, no Ollama, no API keys, no data leaves your machine.
+**Hybrid search · Cross-encoder reranking · 35 file formats · 100% local · Zero cloud · Enterprise-grade plumbing built-in.**
-```
-pip install knowledge-rag → restart Claude Code → search_knowledge("your query")
+```bash
+pip install knowledge-rag   →   restart Claude Code   →   search_knowledge("your query")
 ```
----
-**13 MCP Tools** | **Hybrid Search + Reranking** | **20 File Formats** | **Optional NVIDIA GPU** | **100% Local**
-[What's New](#whats-new-in-v420) | [Supported Formats](#supported-formats) | [Installation](#installation) | [Configuration](#configuration) | [API Reference](#api-reference) | [Architecture](#architecture)
+[Quick Start](#quick-start-3-minutes-from-zero-to-your-first-query) ·
+[Why knowledge-rag](#why-knowledge-rag) ·
+[Compare](#how-knowledge-rag-compares-to-other-rag-frameworks) ·
+[Enterprise Features](#enterprise-features-built-in-zero-configuration) ·
+[Docs](#documentation)
 </div>
 ---
-## Star History
+## ⭐ Star History
 <div align="center">
 <a href="https://www.star-history.com/?repos=lyonzin%2Fknowledge-rag&type=date&legend=top-left">
-  <img alt="Star History Chart" src="./docs/star-history.svg" width="720" />
+  <img alt="knowledge-rag star history chart — GitHub star growth over time" src="./docs/star-history.svg" width="720" />
 </a>
 <sub>Chart updated daily by <a href="./.github/workflows/update-star-history.yml">GitHub Action</a></sub>
@@ -49,1859 +76,664 @@ pip install knowledge-rag → restart Claude Code → search_knowledge("your que
 ---
-## What's New in v4.6.0
-### MCP spec 2026-07-28 via Anthropic Tier 1 SDK (v4.6.0)
-Adopts the [**MCP spec 2026-07-28**](https://blog.modelcontextprotocol.io/posts/2026-07-28/) — stateless request/response core, per-request `_meta.io.modelcontextprotocol/protocolVersion` + `clientCapabilities`, `serverInfo` on every response, retirement of the `initialize`/`initialized` handshake and the `Mcp-Session-Id` header. Delivered by moving directly to the **Anthropic Tier 1 Python SDK** (`mcp>=2.0.0,<3.0.0`, published 2026-07-28).
-**What changed under the hood**:
-- `mcp>=1.6.0,<2.0.0` → **`mcp>=2.0.0,<3.0.0`**
-- `from mcp.server.fastmcp import FastMCP` → `from mcp.server import MCPServer`
-- `FastMCP(name, host=, port=)` → `MCPServer(name, version="4.6.0")` — `host` / `port` moved to `mcp.run(transport=..., host=..., port=...)` on non-stdio transports (per v2 API)
-- Server now advertises `version` in `serverInfo`, matching the 2026-07-28 spec recommendation
-**Zero user-facing changes** — `@mcp.tool()` / `@mcp.resource()` / `@mcp.prompt()` decorator ergonomics are unchanged. All 13 MCP tool signatures frozen. **stdio users see zero behaviour change**. Existing clients (Claude Code, Claude Desktop, Cursor, Windsurf, VS Code Copilot, Cline, Gemini CLI, Zed) negotiate the spec version per request and continue to work.
-**Why the Tier 1 SDK and not the third-party `fastmcp` package**: an early experiment with jlowin's [`fastmcp`](https://gofastmcp.com) tripped the Pillar 5 perf gate — `test_bench_orchestrator_idle_rss` +21.9% and `test_bench_query_cache_5000_entries` +17.1% RSS from the ~20 transitive deps its `[client,server]` extras pull in. Cutting the extras broke `@mcp.tool()` at runtime. Anthropic's `mcp 2.x` is the direct upstream reference — no third-party intermediary, no dependency bloat. Full details in the [v4.6.0 changelog entry](#v460-2026-07-30--mcp-spec-2026-07-28-via-anthropic-tier-1-sdk-mcp-2x) and closed PR #134.
-### Search Performance & Output Quality (v4.2.0)
-**128× faster BM25 search** — replaced `rank-bm25` full-corpus scan with a custom **inverted-index** implementation. Only documents containing query terms are scored, using `numpy.argpartition` for O(n) top-k selection. Adjacent chunk fetching now uses a single batched ChromaDB call instead of N round-trips, and an O(1) reverse lookup (`_source_to_docid`) eliminates linear scans.
-**Smarter output** — two new parameters on `search_knowledge`:
-- **`snippet_mode`** (default: `true`) — truncates content to ~500 characters at natural break points, reducing token consumption by ~72%. Adds `content_length` field with original size; use `get_document()` for full content.
-- **`min_score`** — filters results below a normalized relevance threshold (0.0–1.0). Eliminates low-quality noise from results. Response includes `filtered_by_score` count for transparency.
-Both parameters are fully backwards-compatible (existing callers see no change in behavior).
-### Enterprise Concurrent Access — SSE/HTTP Transport (v4.0.0)
-The server now supports **SSE** and **streamable-http** transport modes. Instead of spawning a separate process per client (stdio), a single server process serves all clients with shared resources — 1 embedding model, 1 ChromaDB, 1 query cache.
-```yaml
-# config.yaml
-server:
-  transport: "sse"        # "stdio" | "sse" | "streamable-http"
-  host: "127.0.0.1"
-  port: 8179
-```
-Or via CLI: `knowledge-rag --transport sse`
-**Optional enterprise features** (all disabled by default):
-- **Rate limiting**: Sliding-window counter, configurable RPM and burst
-- **Prometheus metrics**: `/metrics` endpoint on separate port
-- **Bearer auth**: Token validation for SSE/HTTP connections
-All 13 MCP tools are instrumented with `@rate_limited` and `@instrument` decorators — zero overhead when features are disabled. Default transport remains **stdio** for full backwards compatibility.
-> **Migration**: Existing users need zero changes. SSE mode is opt-in via `server.transport: "sse"` in config.yaml. See [Configuration](#configuration) for details.
-### Quality Gate — 7-Pillar PR Validation
-Every PR (including dependabot bumps and one-line fixes) is now evaluated against **35+ automated checks** spread across 7 pillars before any human review:
-| Pillar | What it enforces | Tools |
-|---|---|---|
-| **1 Security** | SAST, secrets, CVEs, supply chain | bandit, semgrep, gitleaks, pip-audit, dependency-review, Snyk, CodeQL, Socket |
-| **2 Stability** | Flake detection, coverage trend, test count, deterministic runs | pytest-rerunfailures, codecov ±0.5pp, test-count guard |
-| **3 Memory Leak** | RSS bounded under 1000-query load, no idle bloat | psutil-based baseline tests + nightly 50K-iteration soak |
-| **4 Versatility** | 9 OS×Python combos, 14 format parsers, 4 config presets, locale tolerance, property-based fuzzing | matrix CI on Linux+Windows+macOS × 3.11+3.12+3.13, Hypothesis |
-| **5 Scalability** | Performance regression > 10% blocks merge, public bench dashboard | pytest-benchmark, GH Pages chart |
-| **6 Versioning** | Atomic version sync, API surface diff, conventional commits, CHANGELOG enforcement, backwards compat | griffe-style AST diff, custom guards |
-| **7 Quality** | Type strictness, docstring coverage, complexity, dead code | mypy strict, interrogate ≥80%, radon, vulture |
-Plus a **nightly resilience workflow** that runs chaos failure-injection (HF down, ChromaDB corruption, watchdog crash, ONNX zero-byte replay), determinism check (full suite × 3), and mutation testing on selected modules.
-Read the full philosophy in [CONTRIBUTING.md](CONTRIBUTING.md). Report bugs via [SECURITY.md](SECURITY.md) or the [issue templates](.github/ISSUE_TEMPLATE/).
-### Critical Hotfix — No More Silent Zero-Vector Corruption (v3.8.1)
-`FastEmbedEmbeddings.__call__` no longer swallows exceptions and returns `[[0.0]*dim, ...]` when the ONNX model fails to load. That bug pre-existed in master but was silent: ChromaDB happily stored zero embeddings, `count()` reported normal numbers, smart-reindex skipped them as "already indexed", and queries returned garbage similarity with no error visible. Now raises `EmbeddingModelLoadError` / `EmbeddingError` loudly. **All v3.8.0 users should upgrade.** Full details in [Changelog](#v381-2026-05-10--hotfix).
+## 🎯 Why knowledge-rag
-### Lazy-Loaded Embeddings — Cheaper Idle Processes (v3.8.0)
+Most RAG frameworks fall into one of three traps: (1) they require you to ship your data to a cloud API, (2) they hand you 300 building blocks and 0 opinionated defaults, or (3) they bundle RAG as a 5% feature of a much bigger platform you didn't ask for.
-The FastEmbed ONNX model (~200MB resident) now loads on the **first query**, not at startup. Idle `knowledge-rag` processes are now genuinely cheap. Why this matters: MCP stdio is one-process-per-client by protocol — multiple Claude Code windows, Claude Desktop + IDE simultaneously, or review/approval flows that open extra connections all spawn their own processes. Before v3.8.0, every one of them paid the full embedding-model cost up front. Now only processes that actually serve queries load the model. Public API is unchanged.
+**knowledge-rag does one thing well:** it is the MCP-native local RAG server that Claude Code, Cursor, Windsurf, VS Code, Cline, Gemini CLI and Zed can search out of the box — with enterprise plumbing (bearer auth, Prometheus metrics, rate limiting, health probes, structured JSON logging, zero-downtime reindex) that no other RAG-focused OSS ships built-in.
-### Opt-In Single-Instance Guard (v3.8.0)
+<table>
+<tr>
+<td width="50%" valign="top">
-For users who measured their setup and want a hard cap of one server per `data_dir`:
+### 🔒 100% local, 0% cloud
+Your files never leave the machine. No vendor lock-in, no data-residency headache, no forced cloud dependency. **LGPD / GDPR / HIPAA compliant by architecture** — because there is nothing to comply about when nothing leaves.
-```bash
-export KNOWLEDGE_RAG_SINGLE_INSTANCE=1
-```
+</td>
+<td width="50%" valign="top">
-A second instance exits immediately with code 75. **OFF by default** so multi-client MCP usage continues to work unchanged. Stale-PID recovery + SIGINT/SIGTERM cleanup wired correctly. Full guide in [docs/single-instance.md](docs/single-instance.md). Sample MCP config in [examples/mcp-config-single-instance.json](examples/mcp-config-single-instance.json).
+### 🚀 Zero-friction setup
+`pip install knowledge-rag` → restart your MCP client → done. **No Docker mandatory. No Ollama required. No separate embedding server.** Everything runs in-process via FastEmbed ONNX. **Works offline** after the first model download.
-### 5 Ways to Install
+</td>
+</tr>
+<tr>
+<td width="50%" valign="top">
-```bash
-npx -y knowledge-rag                    # NPM — zero setup, auto-manages Python venv
-pip install knowledge-rag               # PyPI — classic Python install
-curl -fsSL .../install.sh | bash        # One-line installer (Linux/macOS/Windows)
-docker pull ghcr.io/lyonzin/knowledge-rag  # Docker — models pre-downloaded
-git clone ... && pip install -r ...     # From source
-```
+### 🛡️ Production-grade OSS
+7-pillar quality gate on every PR (**35+ automated checks**), 9-cell OS×Python CI matrix (Linux + Windows + macOS × 3.11/3.12/3.13), nightly chaos + 50K-iteration soak + mutation testing. **700+ tests. 0 known regressions.**
-All methods produce the same MCP server. See [Installation](#installation) for full instructions.
+</td>
+<td width="50%" valign="top">
-### Recent Highlights
+### 💰 Zero ongoing cost
+No token bills. No SaaS tier. No paid features hidden behind a wall. **MIT license, forever.** Runs on the laptop you already have — GPU optional, CPU works fine with FastEmbed ONNX.
-- **v4.0.0** — **Enterprise concurrent access**: SSE/HTTP transport (1 server → N clients), thread-safe shared state, optional rate limiting + Prometheus metrics, ChromaDB WAL mode, `--transport` CLI
-- **v3.9.0** — **Quality Gate** activated: 35+ automated PR checks across 7 pillars (Security, Stability, Memory Leak, Versatility, Scalability, Versioning, Quality) + nightly resilience suite (chaos, soak, determinism, mutation)
-- **v3.8.1** — Critical hotfix: loud-fail embeddings (no more silent zero-vector corruption); Windows CI flake erradicated (HF_HUB_OFFLINE + shell:bash + atexit wrapper)
-- **v3.8.0** — Lazy-load embeddings, opt-in single-instance guard, version sync across PyPI/NPM/Docker
-- **v3.6.0** — Multi-language code parsing (C/C++/JS/TS/XML), NPM wrapper, Docker image, automated release pipeline
-- **v3.5.2** — CUDA DLL auto-discovery from pip packages, graceful GPU→CPU fallback, explicit CPU provider (no CUDA noise when `gpu: false`), BASE_DIR resolution fix for editable installs
-- **v3.5.1** — Remove Python `<3.13` upper bound — 3.13 and 3.14 now supported
-- **v3.5.0** — Optional GPU acceleration, supported formats table, full README rewrite
-- **v3.4.3** — MCP stdout save/restore fix (v3.4.2 broke JSON-RPC responses)
-- **v3.4.0** — Persistent model cache, exclude patterns, Jupyter Notebook parser, inotify resilience, MetaTrader support
-See [Changelog](#changelog) for full history.
+</td>
+</tr>
+</table>
 ---
-## Supported Formats
-| Format | Extension | Parser | Default | Notes |
-|--------|-----------|--------|---------|-------|
-| Markdown | `.md` | Section-aware (splits at `##`) | Yes | Headers preserved as chunk boundaries |
-| Plain Text | `.txt` | Fixed-size chunking | Yes | 1000 chars + 200 overlap |
-| PDF | `.pdf` | PyMuPDF extraction | Yes | Text-based PDFs only (no OCR) |
-| Python | `.py` | Code-aware parser | Yes | Functions/classes as chunks |
-| JSON | `.json` | Structure-aware | Yes | Flattened key-value extraction |
-| CSV | `.csv` | Row-based parser | Yes | Headers + rows as text |
-| Word | `.docx` | python-docx | Yes | Headings preserved as markdown |
-| Excel | `.xlsx` | openpyxl | Yes | Sheet-by-sheet extraction |
-| PowerPoint | `.pptx` | python-pptx | Yes | Slide-by-slide extraction |
-| Jupyter Notebook | `.ipynb` | Cell-aware parser | Yes | Markdown + code cells only, no outputs/base64 |
-| C Source | `.c` | Code-aware parser | Yes | Functions/structs/includes extracted |
-| C/C++ Header | `.h` | Code-aware parser | Yes | Function declarations/structs extracted |
-| C++ Source | `.cpp` | Code-aware parser | Yes | Classes/structs/includes extracted |
-| JavaScript | `.js` | Code-aware parser | Yes | Functions/classes/imports (ESM + CJS) |
-| React JSX | `.jsx` | Code-aware parser | Yes | Same as JS parser |
-| TypeScript | `.ts` | Code-aware parser | Yes | Functions/classes/interfaces/enums/imports |
-| React TSX | `.tsx` | Code-aware parser | Yes | Same as TS parser |
-| XML | `.xml` | XML parser | Yes | Root element and namespace extraction |
-| MQL4 Header | `.mqh` | Code parser | No | MetaTrader — add to `supported_formats` to enable |
-| MQL4 Source | `.mq4` | Code parser | No | MetaTrader — add to `supported_formats` to enable |
-> **Tip:** The parser dispatch is extensible. Any format mapped in `_parsers` can be enabled via `supported_formats` in config.yaml.
----
-## Features
-| Feature | Description |
-|---------|-------------|
-| **Hybrid Search** | Semantic + BM25 keyword search with Reciprocal Rank Fusion |
-| **Cross-Encoder Reranker** | Xenova/ms-marco-MiniLM-L-6-v2 re-scores top candidates for precision |
-| **GPU Acceleration** | Optional ONNX CUDA support for 5-10x faster indexing |
-| **YAML Configuration** | Fully customizable via `config.yaml` with domain-specific presets |
-| **Query Expansion** | Configurable synonym mappings (69 security-term defaults) |
-| **Markdown-Aware Chunking** | `.md` files split by `##`/`###` sections instead of fixed windows |
-| **In-Process Embeddings** | FastEmbed ONNX Runtime (BAAI/bge-small-en-v1.5, 384D) |
-| **Keyword Routing** | Word-boundary aware routing for domain-specific queries |
-| **20 Format Parsers** | MD, TXT, PDF, PY, C, H, CPP, JS, JSX, TS, TSX, JSON, XML, CSV, DOCX, XLSX, PPTX, IPYNB + opt-in MQH/MQ4 |
-| **Category Organization** | Organize docs by folder, auto-tagged by path |
-| **Incremental Indexing** | Change detection via mtime/size — only re-indexes modified files |
-| **Chunk Deduplication** | SHA256 content hashing prevents duplicate chunks |
-| **Query Cache** | LRU cache with 5-min TTL for instant repeat queries |
-| **Document CRUD** | Add, update, remove documents via MCP tools |
-| **URL Ingestion** | Fetch URLs, strip HTML, convert to markdown, index |
-| **Similarity Search** | Find documents similar to a reference document |
-| **Retrieval Evaluation** | Built-in MRR@5 and Recall@5 metrics |
-| **File Watcher** | Auto-reindex on document changes via watchdog (5s debounce) |
-| **Exclude Patterns** | Glob-based file/directory exclusion during indexing |
-| **MMR Diversification** | Maximal Marginal Relevance reduces redundant results |
-| **Persistent Model Cache** | Embedding models cached in `models_cache/` — survives reboots |
-| **Auto-Migration** | Detects embedding dimension mismatch and rebuilds automatically |
-| **13 MCP Tools** | Full CRUD + search + evaluation via Claude Code |
----
-## Architecture
-### System Overview
-```mermaid
-flowchart TB
-    subgraph MCP["MCP SERVER (FastMCP)"]
-        direction TB
-        TOOLS["13 MCP Tools (frozen, LEI 1)<br/>search_knowledge | get_document | search_similar<br/>add_document | add_from_url | update_document | remove_document<br/>reindex_documents | get_reindex_status<br/>list_categories | list_documents | get_index_stats | evaluate_retrieval"]
-    end
-    subgraph SEARCH["SEARCH DISPATCH (v4.8.2+)"]
-        direction TB
-        SM["search_method dispatch<br/>auto | hybrid | fts5"]
-        QROUTER["QueryRouter (regex)<br/>lexical vs semantic<br/>(ADR-002)"]
-        FTS5PATH["FTS5 Fast-Path<br/>(exact identifiers <10ms)"]
-        HYBRIDPATH["Hybrid Pipeline<br/>(conceptual queries)"]
-        SM --> QROUTER
-        QROUTER -->|lexical| FTS5PATH
-        QROUTER -->|semantic| HYBRIDPATH
-        FTS5PATH -.->|not_ready / low_hits<br/>fallback| HYBRIDPATH
-    end
-    subgraph HYBRID["HYBRID PIPELINE"]
-        direction LR
-        KWROUTER["Keyword Router<br/>(word boundaries → category filter)"]
-        SEMANTIC["Semantic Search<br/>(ChromaDB)"]
-        BM25["BM25 Keyword<br/>(inverted-index + expansion)"]
-        RRF["Reciprocal Rank<br/>Fusion (RRF)"]
-        RERANK["Cross-Encoder<br/>Reranker"]
-        KWROUTER --> SEMANTIC
-        KWROUTER --> BM25
-        SEMANTIC --> RRF
-        BM25 --> RRF
-        RRF --> RERANK
-    end
-    subgraph STORAGE["STORAGE LAYER"]
-        direction LR
-        CHROMA[("ChromaDB<br/>data/chroma_db/<br/>(vector store)")]
-        FTS5DB[("SQLite FTS5<br/>data/fts5_index.db<br/>(lexical index, ADR-001)")]
-        COLLECTIONS["8 Categories<br/>redteam | blueteam | ctf<br/>security | logscale<br/>development | aar | general"]
-        CHROMA --- COLLECTIONS
-        FTS5DB --- COLLECTIONS
-    end
-    subgraph EMBED["EMBEDDINGS (In-Process)"]
-        FASTEMBED["FastEmbed ONNX<br/>BAAI/bge-small-en-v1.5<br/>(384D, CPU or GPU)"]
-        CROSSENC["Cross-Encoder<br/>ms-marco-MiniLM-L-6-v2"]
-        FASTEMBED --- CROSSENC
-    end
-    subgraph INGEST["DOCUMENT INGESTION"]
-        PARSERS["20 Parsers<br/>MD | PDF | TXT | PY | C | H | CPP | JS | JSX | TS | TSX | JSON | XML | CSV<br/>DOCX | XLSX | PPTX | IPYNB | MQH | MQ4"]
-        CHUNKER["Chunking<br/>MD: section-aware<br/>Other: 1000 chars + 200 overlap"]
-        FTS5SYNC["FTS5 CRUD sync<br/>(v4.8.2 task 05)"]
-        PARSERS --> CHUNKER --> FTS5SYNC
-    end
-    CLAUDE["Claude Code"] --> MCP
-    MCP --> SEARCH
-    HYBRIDPATH --> HYBRID
-    FTS5PATH --> FTS5DB
-    HYBRID --> STORAGE
-    STORAGE --> EMBED
-    INGEST --> EMBED
-    EMBED --> STORAGE
-    FTS5SYNC --> FTS5DB
-```
-### Query Processing Flow
-```mermaid
-flowchart TB
-    QUERY["User Query<br/>'mimikatz credential dump' | 'CVE-2021-4034'"] --> METHOD
-    subgraph DISPATCH["Dispatch (v4.8.2+, ADR-006)"]
-        METHOD{"search_method<br/>auto | hybrid | fts5"}
-        AUTOROUTE["QueryRouter.classify()<br/>regex-based lexical detection"]
-        FASTPATH["FTS5 Fast-Path<br/>SQLite MATCH<br/>(&lt;10ms cold, &lt;2ms hot)"]
-        NOTREADY{"FTS5 ready<br/>AND hits >= min_hits?"}
-        METHOD -->|auto| AUTOROUTE
-        METHOD -->|fts5| FASTPATH
-        METHOD -->|hybrid| EXPAND
-        AUTOROUTE -->|lexical| FASTPATH
-        AUTOROUTE -->|semantic| EXPAND
-        FASTPATH --> NOTREADY
-        NOTREADY -->|no, fallback| EXPAND
-    end
-    subgraph EXPANSION["Query Expansion (hybrid path)"]
-        EXPAND["Synonym Expansion<br/>mimikatz -> mimikatz, sekurlsa, logonpasswords"]
-    end
-    EXPAND --> KWROUTER
-    subgraph ROUTING["Keyword Routing (category filter)"]
-        KWROUTER["Keyword Router<br/>(word boundaries)"]
-        MATCH{"Word Boundary<br/>Match?"}
-        CATEGORY["Filter: redteam"]
-        NOFILTER["No Filter"]
-        KWROUTER --> MATCH
-        MATCH -->|Yes| CATEGORY
-        MATCH -->|No| NOFILTER
-    end
-    subgraph HYBRID["Hybrid Search"]
-        direction LR
-        SEMANTIC["Semantic Search<br/>(ChromaDB embeddings)<br/>Conceptual similarity"]
-        BM25["BM25 Inverted-Index<br/>(posting lists + numpy top-k)<br/>Exact term matching"]
-    end
-    subgraph FUSION["Result Fusion + Reranking"]
-        RRF["Reciprocal Rank Fusion<br/>score = alpha * 1/(k+rank_sem)<br/>+ (1-alpha) * 1/(k+rank_bm25)"]
-        RERANK["Cross-Encoder Reranker<br/>Re-scores top 3x candidates<br/>query+doc pair scoring"]
-        SORT["Sort by Reranker Score<br/>Normalize to 0-1"]
-        ADJ["Adjacent Chunk Expansion<br/>(batch fetch ±1 chunk)"]
-        RRF --> RERANK --> SORT --> ADJ
-    end
-    subgraph OUTPUT["Output Processing"]
-        MINSCORE["min_score Filter<br/>(discard below threshold)"]
-        SNIPPET["snippet_mode Truncation<br/>(~500 chars at natural break)"]
-        MINSCORE --> SNIPPET
-    end
-    CATEGORY --> HYBRID
-    NOFILTER --> HYBRID
-    SEMANTIC --> RRF
-    BM25 --> RRF
-    ADJ --> MINSCORE
-    NOTREADY -->|yes, hit| MINSCORE
-    SNIPPET --> RESULTS["Results<br/>search_method: fts5 | hybrid | semantic | keyword<br/>routed_by: fts5_router | none<br/>score + filtered_by_score + content_length"]
-```
-### Document Ingestion Flow
-```mermaid
-flowchart LR
-    subgraph INPUT["Input"]
-        FILES["documents/<br/>├── security/<br/>│   ├── redteam/<br/>│   ├── blueteam/<br/>│   └── ctf/<br/>├── aar/<br/>├── logscale/<br/>├── development/<br/>└── general/"]
-    end
-    subgraph PARSE["Parse (20 formats)"]
-        MD["Markdown"]
-        PDF["PDF<br/>(PyMuPDF)"]
-        OFFICE["DOCX | XLSX<br/>PPTX | CSV"]
-        CODE["PY | C | H | CPP | JS | JSX<br/>TS | TSX | JSON | XML | IPYNB"]
-    end
-    subgraph CHUNK["Chunk"]
-        MDSPLIT["MD: Section-Aware<br/>Split at ## headers"]
-        TXTSPLIT["Other: Fixed-Size<br/>1000 chars + 200 overlap"]
-        DEDUP["SHA256 Dedup<br/>Skip duplicate content"]
-    end
-    subgraph EMBED["Embed"]
-        FASTEMBED["FastEmbed ONNX<br/>bge-small-en-v1.5<br/>(384D, CPU or GPU)"]
-    end
-    subgraph DISPATCH["Write Dispatch (v4.8.3, #161)"]
-        WCOL{"_write_collection<br/>routes writes"}
-        STAGING["Staging Collection<br/>(nuclear_rebuild only,<br/>keeps prod serving queries)"]
-        PROD["Production Collection<br/>(default)"]
-        WCOL -->|_staging_target set| STAGING
-        WCOL -->|default| PROD
-    end
-    subgraph STORE["Store"]
-        CHROMADB[("ChromaDB<br/>data/chroma_db/")]
-        BM25IDX["BM25 Index<br/>(in-memory,<br/>rebuilt on write)"]
-        FTS5DB[("SQLite FTS5<br/>data/fts5_index.db<br/>(CRUD-synced, ADR-008)")]
-    end
-    FILES --> MD & PDF & OFFICE & CODE
-    MD --> MDSPLIT
-    PDF & OFFICE & CODE --> TXTSPLIT
-    MDSPLIT --> DEDUP
-    TXTSPLIT --> DEDUP
-    DEDUP --> EMBED
-    EMBED --> DISPATCH
-    STAGING --> CHROMADB
-    PROD --> CHROMADB
-    PROD --> BM25IDX
-    PROD --> FTS5DB
-```
-### hybrid_alpha Parameter Effect
-`hybrid_alpha` weights RRF fusion between semantic and BM25 rankings on the **hybrid pipeline only**. When `search_method="auto"` and the QueryRouter classifies the query as lexical (e.g. `CVE-2021-4034`, `MDR-AD002`, `T1078.001`, file hashes), the FTS5 fast-path fires and `hybrid_alpha` is not consulted — FTS5 uses SQLite's native `bm25()` scoring exclusively. Pass `search_method="hybrid"` to force RRF fusion + rerank on every query if you want deterministic hybrid semantics regardless of the query shape.
-```mermaid
-flowchart LR
-    subgraph ALPHA["hybrid_alpha values (hybrid path only)"]
-        A0["0.0<br/>Pure BM25<br/>Instant"]
-        A3["0.3 (default)<br/>Keyword-heavy<br/>Fast"]
-        A5["0.5<br/>Balanced"]
-        A7["0.7<br/>Semantic-heavy"]
-        A10["1.0<br/>Pure Semantic"]
-    end
-    subgraph USE["Best For"]
-        U0["CVEs, tool names<br/>exact matches<br/>(consider FTS5 fast-path)"]
-        U3["Technical queries<br/>specific terms"]
-        U5["General queries"]
-        U7["Conceptual queries<br/>related topics"]
-        U10["'How to...' questions<br/>conceptual search"]
-    end
-    A0 --- U0
-    A3 --- U3
-    A5 --- U5
-    A7 --- U7
-    A10 --- U10
-```
+## 📊 How knowledge-rag compares to other RAG frameworks
+We audited **16 popular RAG frameworks and platforms** (LlamaIndex, LangChain, ChromaDB, Weaviate, Qdrant, RAGFlow, LightRAG, DSPy, GraphRAG, Haystack, RAG-Anything, kotaemon, txtai, llmware, Dify, open-webui, FastGPT) so you can pick honestly.
+**Legend:** ✅ built-in · 🟡 plugin / paid tier / partial · ❌ not available · ⚠️ license or default concern
+| Dimension | 🎯 **knowledge-rag** | LlamaIndex | LangChain | Haystack | RAGFlow | txtai | open-webui | Dify | Qdrant |
+|---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
+| **100% local, zero cloud** | ✅ | 🟡 | ✅ | 🟡 | 🟡 | ✅ | ✅ | 🟡 | 🟡 |
+| **MCP native (Claude/Cursor)** | ✅ 13 tools | 🟡 pkg | 🟡 adapter | 🟡 wrapper | 🟡 add-on | ✅ | ✅ consumer | ✅ | ❌ |
+| **Hybrid BM25 + semantic** | ✅ 128× faster | 🟡 | 🟡 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| **Cross-encoder rerank** | ✅ builtin | ❌ | 🟡 | ✅ | ✅ fused | ❌ | ✅ | 🟡 | 🟡 |
+| **Bearer auth builtin** | ✅ | ❌ | ❌ | ❌ core | ❌ | 🟡 | ✅ RBAC | ✅ OAuth2 | ✅ |
+| **Prometheus `/metrics`** | ✅ | ❌ | ❌ | ❌ core | ❌ | ❌ | ✅ OTel | ❌ | ✅ |
+| **Rate limiting** | ✅ sliding-window | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ |
+| **Health probes** (`/health`) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | 🟡 | 🟡 | ✅ |
+| **Structured JSON logging** | ✅ opt-in | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ OTel | 🟡 | ✅ |
+| **Zero-downtime reindex** | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
+| **Async background reindex** | ✅ + polling | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | 🟡 |
+| **GPU CUDA optional** | ✅ 12 auto | ❌ | 🟡 | ✅ | ✅ | ✅ | ✅ | 🟡 | 🟡 |
+| **File formats builtin** | ✅ **20** | 0 (LlamaParse=$) | 50+ plugins | ✅ **36+** | 8+ | ? | ? | ~10 | ❌ |
+| **Setup < 5 min POC** | ✅ pip 1-liner | ✅ | ✅ | ✅ | ❌ 16GB RAM | ✅ | ✅ docker | ✅ docker | ✅ |
+| **Nightly chaos + soak + mutation** | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
+| **License** | ✅ MIT | MIT | MIT | Apache-2.0 | Apache-2.0 | Apache-2.0 | ⚠️ preserving | ⚠️ restrictive | Apache-2.0 |
+> **The 5 dimensions where knowledge-rag is unique:** health probes + JSON logging + Prometheus + rate limit + bearer auth **simultaneously built-in on an OSS RAG-focused MCP server**. Zero-downtime reindex + async background reindex + nightly chaos/soak/mutation are documented on nobody else's README.
 ---
-## Installation
-### Prerequisites
-- Python 3.11+
-- Claude Code CLI
-- *…or any other MCP client (Claude Desktop, Cursor, VS Code, Antigravity, opencode, Windsurf) — see [Use with other MCP clients](#use-with-other-mcp-clients)*
-- ~200MB disk for model cache (auto-downloaded on first run)
-- *Optional:* NVIDIA GPU + CUDA 12 for accelerated embeddings (see [GPU Acceleration](#gpu-acceleration) below)
-### GPU Acceleration
-GPU mode accelerates embedding generation during indexing and search. It requires an NVIDIA GPU with CUDA 12 support. No GPU? No problem — the server runs on CPU by default and GPU is entirely optional.
-**Requirements:**
-| Component | Minimum | How to check / get it |
-|-----------|---------|----------------------|
-| NVIDIA GPU (Turing+) | RTX 20xx / 30xx / 40xx / 50xx, or Tesla T4+ | `nvidia-smi` |
-| NVIDIA Driver | ≥ 525 | `nvidia-smi` — [nvidia.com/drivers](https://www.nvidia.com/drivers) |
-| CUDA 12 runtime | Provided by pip packages below | Automatic |
-**Setup (2 steps):**
-```bash
-# 1. Install GPU dependencies (onnxruntime-gpu + all CUDA 12 runtime DLLs)
-pip install knowledge-rag[gpu]
-# 2. Enable in config.yaml
-# models:
-#   embedding:
-#     gpu: true
-```
-The `[gpu]` extra installs `onnxruntime-gpu` plus 7 NVIDIA CUDA 12 packages (`cublas`, `cudnn`, `cuda-runtime`, `cufft`, `cusparse`, `cusolver`, `curand`, `nvjitlink`) so you don't need a full CUDA Toolkit install.
-**Verify GPU is active:**
-On server startup, look for the GPU status banner:
-```
-============================================================
-  GPU STATUS: ACTIVE
-  Provider:   CUDAExecutionProvider
-  Device:     NVIDIA GeForce RTX 3080 Ti
-  VRAM:       12.0 GB
-============================================================
-```
-Or programmatically:
-```bash
-python -c "import onnxruntime; print(onnxruntime.get_available_providers())"
-# Should include: 'CUDAExecutionProvider'
-```
-> **Fallback**: If CUDA is unavailable at runtime (wrong driver, missing DLLs, no GPU), the server falls back to CPU automatically with a `[WARN]` log — it never crashes. The `gpu: true` config is a preference, not a requirement.
-### Install Methods
-Pick one — all produce the same running server.
-#### Option A: NPX (fastest)
-Requires Node.js 16+. Handles Python venv, pip install, and version upgrades automatically.
-```bash
-claude mcp add knowledge-rag -s user -- npx -y knowledge-rag
-```
-That's it. On first run, `npx` creates a venv at `~/.knowledge-rag/`, installs the PyPI package, and starts the MCP server. Subsequent runs reuse the cached venv.
+## 🚀 Quick Start (3 minutes, from zero to your first query)
-#### Option B: One-line installer
+Pick your integration path — knowledge-rag ships the same server through every channel.
-```bash
-# Linux/macOS:
-curl -fsSL https://raw.githubusercontent.com/lyonzin/knowledge-rag/master/install.sh | bash
-# Windows (PowerShell):
-irm https://raw.githubusercontent.com/lyonzin/knowledge-rag/master/install.ps1 | iex
-```
-Then configure Claude Code:
+### Path 1 — Claude Code, Cursor, Windsurf, Cline, VS Code, Gemini CLI, Zed (MCP)
 ```bash
-claude mcp add knowledge-rag -s user -- ~/knowledge-rag/venv/bin/python -m mcp_server.server
-```
-> **Windows**: `claude mcp add knowledge-rag -s user -- %USERPROFILE%\knowledge-rag\venv\Scripts\python.exe -m mcp_server.server`
-#### Option C: pip install
-```bash
-mkdir ~/knowledge-rag && cd ~/knowledge-rag
-python3 -m venv venv && source venv/bin/activate
 pip install knowledge-rag
-knowledge-rag init              # Exports config template, presets, creates documents/
+knowledge-rag init                    # scaffolds config.yaml + documents/
 ```
-Then configure Claude Code:
+Drop your PDFs, markdown, code files into `documents/`. Restart your MCP client. Ask it:
-```bash
-claude mcp add knowledge-rag -s user -- ~/knowledge-rag/venv/bin/python -m mcp_server.server
 ```
-> **Windows users**: Use `python` instead of `python3`, `venv\Scripts\activate` instead of `source venv/bin/activate`.
-> **Windows path**: `claude mcp add knowledge-rag -s user -- %USERPROFILE%\knowledge-rag\venv\Scripts\python.exe -m mcp_server.server`
-#### Option D: Clone from source
-```bash
-git clone https://github.com/lyonzin/knowledge-rag.git ~/knowledge-rag
-cd ~/knowledge-rag
-python3 -m venv venv && source venv/bin/activate
-pip install -r requirements.txt
+search_knowledge("your query")
 ```
-Then configure Claude Code:
-```bash
-claude mcp add knowledge-rag -s user -- ~/knowledge-rag/venv/bin/python -m mcp_server.server
-```
+That's it. First query loads the ONNX embedding model (~200MB, one-off download). Subsequent queries are cached and hit sub-second latency.
-#### Option E: Docker
+### Path 2 — HTTP / SSE server (multi-user, air-gapped, load-balanced)
-```bash
-docker pull ghcr.io/lyonzin/knowledge-rag:latest
+```yaml
+# config.yaml
+server:
+  transport: "sse"                    # or "streamable-http"
+  host: "0.0.0.0"
+  port: 8179
+  auth:
+    bearer_token: "your-secret-token"
+  rate_limit:
+    enabled: true
+    requests_per_minute: 60
+  metrics:
+    enabled: true
+    port: 9179
+  logging:
+    format: "json"                    # ELK / Loki / Datadog / CloudWatch ready
 ```
 ```bash
-claude mcp add knowledge-rag -s user -- \
-  docker run -i --rm \
-  -v ~/knowledge-rag/documents:/app/documents \
-  -v ~/knowledge-rag/data:/app/data \
-  ghcr.io/lyonzin/knowledge-rag:latest
+knowledge-rag --transport sse
 ```
-Models are pre-downloaded in the image — no first-run delay.
-<details>
-<summary>Alternative: manual JSON config</summary>
+- Health probe: `curl http://your-host:8179/health` → 200 + JSON payload
+- Prometheus scrape: `http://your-host:9179/metrics`
+- MCP dispatcher: authenticated via `Authorization: Bearer your-secret-token`
-Add to `~/.claude.json`:
-**Windows:**
-```json
-{
-  "mcpServers": {
-    "knowledge-rag": {
-      "command": "C:\\Users\\YOUR_USER\\knowledge-rag\\venv\\Scripts\\python.exe",
-      "args": ["-m", "mcp_server.server"]
-    }
-  }
-}
-```
-**Linux / macOS:**
-```json
-{
-  "mcpServers": {
-    "knowledge-rag": {
-      "command": "/home/YOUR_USER/knowledge-rag/venv/bin/python",
-      "args": ["-m", "mcp_server.server"]
-    }
-  }
-}
-```
-> Replace `YOUR_USER` with your username, or use the full path from `echo $HOME`.
-</details>
-#### Option F: SSE Server Mode (multi-agent)
-For multi-agent setups where multiple clients query the same knowledge base simultaneously:
+### Path 3 — Docker (models pre-downloaded, air-gapped ready)
 ```bash
-pip install knowledge-rag[server]    # Adds uvicorn for SSE/HTTP
-knowledge-rag --transport sse        # Starts on http://127.0.0.1:8179
-```
-Then configure each MCP client to connect via SSE:
-```json
-{
-  "mcpServers": {
-    "knowledge-rag": {
-      "type": "sse",
-      "url": "http://127.0.0.1:8179/sse"
-    }
-  }
-}
+docker pull ghcr.io/lyonzin/knowledge-rag:latest
+docker run -v $(pwd)/documents:/app/documents -p 8179:8179 ghcr.io/lyonzin/knowledge-rag:latest
 ```
-One server process serves all agents — shared embedding model, shared cache, shared ChromaDB. See [Configuration > Server](#server) for rate limiting, metrics, and auth options.
-### Use with other MCP clients
-`knowledge-rag` supports both **stdio** (default, 1:1) and **SSE** (1:N) transport modes. In stdio mode, it works with any MCP-compatible client, not only Claude Code. The launch command is the same everywhere (the `python -m mcp_server.server` from whichever install method you picked); only the **config file location** and **JSON shape** differ per client.
+**Full installation guide with all 5 methods, 8 MCP client configurations, and GPU setup:** [docs/INSTALLATION.md →](docs/INSTALLATION.md)
-#### Clients using the standard `mcpServers` format
+---
-For **Claude Desktop, Cursor, Antigravity, and Windsurf**, use the same block — only the file location changes:
+## 🤖 Ready-to-use skills for AI agents
-```json
-{
-  "mcpServers": {
-    "knowledge-rag": {
-      "command": "/home/YOUR_USER/knowledge-rag/venv/bin/python",
-      "args": ["-m", "mcp_server.server"]
-    }
-  }
-}
-```
+Installing knowledge-rag gives your agent 13 MCP tools. It does not tell the agent **when** to use them. That is what the [`skills/`](skills/) folder solves — drop-in behavioural skills for Claude Code, Cursor, Windsurf, Cline, Zed, VS Code Copilot that turn "AI with access to RAG" into "AI that actually uses RAG first".
-> **Windows**: set `command` to the full path of `venv\Scripts\python.exe`.
+**10 skills, MIT licensed, organized by kind:**
-| Client | Config file | Notes |
+| # | Skill | What it does |
 |---|---|---|
-| **Claude Code** | use `claude mcp add …` (see install methods above) | The CLI writes `~/.claude.json` for you — manual edits to it aren't reliably picked up. |
-| **Claude Desktop** | macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` · Windows: `%APPDATA%\Claude\claude_desktop_config.json` | Easiest: **Settings → Developer → Edit Config** opens the correct file (avoids the Windows Store/MSIX path quirk). |
-| **Cursor** | `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (per project) | — |
-| **Antigravity** | macOS/Linux: `~/.gemini/antigravity/mcp_config.json` · Windows: `%USERPROFILE%\.gemini\antigravity\mcp_config.json` | Open via Agent panel → **"…" → Manage MCP Servers → View raw config**. |
-| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` (global only) | Easiest: Cascade panel → MCP → **View raw config**. |
-#### VS Code — uses a `servers` key
-VS Code (Copilot MCP) nests servers under **`servers`**, not `mcpServers`. Put this in `.vscode/mcp.json` (workspace) or the file opened by the **MCP: Open User Configuration** command:
-```json
-{
-  "servers": {
-    "knowledge-rag": {
-      "type": "stdio",
-      "command": "/home/YOUR_USER/knowledge-rag/venv/bin/python",
-      "args": ["-m", "mcp_server.server"]
-    }
-  }
-}
-```
-#### opencode — uses an `mcp` key
-opencode nests servers under **`mcp`**, takes `command` as a single **array**, and uses `environment` instead of `env`. Put this in `opencode.json` (project root) or `~/.config/opencode/opencode.json` (global):
-```jsonc
-{
-  "$schema": "https://opencode.ai/config.json",
-  "mcp": {
-    "knowledge-rag": {
-      "type": "local",
-      "command": ["/home/YOUR_USER/knowledge-rag/venv/bin/python", "-m", "mcp_server.server"],
-      "enabled": true
-    }
-  }
-}
-```
-> **Any other MCP client**: point it at the same command + args (`…/venv/bin/python -m mcp_server.server`). If it speaks stdio MCP, knowledge-rag works — only the config file's location and key naming differ. Check your client's docs for the exact path.
-### Verify
+| 1 | [`rag-check-first`](skills/foundation/rag-check-first/SKILL.md) | Search the corpus **before** answering any technical claim |
+| 2 | [`rag-cite-sources`](skills/foundation/rag-cite-sources/SKILL.md) | Every claim ships with `path:line` citations |
+| 3 | [`rag-onboard-context`](skills/foundation/rag-onboard-context/SKILL.md) | First interaction of a session probes what is indexed |
+| 4 | [`rag-deep-dive`](skills/workflow/rag-deep-dive/SKILL.md) | 3-step drill: `search` → `fetch` → `find similar` |
+| 5 | [`rag-web-fallback`](skills/workflow/rag-web-fallback/SKILL.md) | Only hit the web when local RAG comes back empty |
+| 6 | [`rag-troubleshoot`](skills/workflow/rag-troubleshoot/SKILL.md) | Bug / error → RAG first for prior fixes |
+| 7 | [`rag-code-review`](skills/workflow/rag-code-review/SKILL.md) | Review consults ADRs / patterns before commenting |
+| 8 | [`rag-index-decisions`](skills/maintenance/rag-index-decisions/SKILL.md) | After a decision, index it back — close the feedback loop |
+| 9 | [`rag-security-first`](skills/domain/rag-security-first/SKILL.md) | Security tasks: MITRE / CVE / runbook first |
+| 10 | [`rag-evaluate-quality`](skills/maintenance/rag-evaluate-quality/SKILL.md) | Weekly checkup — MRR@5 · Recall@5 · Precision@5 |
+**Install — pick the shortest path for your machine:**
 ```bash
-claude mcp list
-```
-On first start, the server will:
-1. Download the embedding model (~50MB, cached in `models_cache/`)
-2. Auto-index any documents in the `documents/` directory
-3. Start watching for file changes (auto-reindex)
----
-## Usage
-### Adding Documents
-Place your documents in the `documents/` directory, organized by category:
-```
-documents/
-├── security/          # Pentest, exploit, vulnerability docs
-├── development/       # Code, APIs, frameworks
-├── ctf/               # CTF writeups and methodology
-├── logscale/          # LogScale/LQL documentation
-└── general/           # Everything else
-```
-Or add documents programmatically via MCP tools:
-```python
-# Add from content
-add_document(
-    content="# My Document\n\nContent here...",
-    filepath="security/my-technique.md",
-    category="security"
-)
-# Add from URL
-add_from_url(
-    url="https://example.com/article",
-    category="security",
-    title="Custom Title"
-)
-```
-### Searching
+# Option 1 — Via skills.sh (needs Node — one command, zero clone)
+npx skills add lyonzin/knowledge-rag
-Claude uses the RAG system automatically when configured. You can also control search behavior:
-```python
-# Pure keyword search — instant, no embedding needed
-search_knowledge("gtfobins suid", hybrid_alpha=0.0)
-# Keyword-heavy (default) — fast, slight semantic boost
-search_knowledge("mimikatz", hybrid_alpha=0.3)
-# Balanced hybrid — both engines equally weighted
-search_knowledge("SQL injection techniques", hybrid_alpha=0.5)
-# Semantic-heavy — better for conceptual queries
-search_knowledge("how to escalate privileges", hybrid_alpha=0.7)
-# Pure semantic — embedding similarity only
-search_knowledge("lateral movement strategies", hybrid_alpha=1.0)
+# Option 2 — Via our install.sh (no Node needed; works on Linux/macOS/WSL/Git Bash)
+curl -fsSL https://raw.githubusercontent.com/lyonzin/knowledge-rag/master/skills/install.sh | bash
 ```
-### Indexing
+Both restart-Claude-Code and you are done. Option 2 supports `--project`, `--only rag-check-first,rag-cite-sources`, `--dry-run`, `--help`.
-Documents are automatically indexed on first startup. All reindex operations run **in background** — they return immediately and you poll progress via `get_reindex_status()`:
+For Cursor, Windsurf, Cline and full manual instructions → [skills/README.md](skills/README.md) · Full catalog with skill chains → [skills/CATALOG.md](skills/CATALOG.md)
-```python
-# Incremental: only re-index changed files (fast)
-reindex_documents()
+---
-# Smart reindex: detect changes + rebuild BM25
-reindex_documents(force=True)
+## 🛠️ The 13 MCP tools your agent gets
-# Nuclear rebuild: delete everything, re-embed all (use after model change)
-reindex_documents(full_rebuild=True)
+Once installed, your AI agent gets these 13 tools automatically:
-# Poll progress (lightweight, no full stats computation)
-get_reindex_status()
-# → {"reindex": {"active": true, "percent": 56, "progress": "2090/3734", ...}}
-```
+| Tool | Purpose |
+|---|---|
+| `search_knowledge` | Hybrid semantic + BM25 with cross-encoder rerank |
+| `get_document` | Retrieve full content of one document |
+| `search_similar` | Find documents similar to a reference |
+| `evaluate_retrieval` | Measure MRR@5 · Recall@5 · Precision@5 |
+| `add_document` | Index a new document via MCP |
+| `update_document` | Re-index a changed document |
+| `remove_document` | Drop a document + all its chunks |
+| `add_from_url` | Fetch, sanitize, and index a URL |
+| `list_documents` | Enumerate indexed documents |
+| `list_categories` | Auto-tagged by folder path |
+| `get_index_stats` | Corpus size, cache hit rate, embedding dim |
+| `reindex_documents` | Smart incremental OR nuclear rebuild |
+| `get_reindex_status` | Live progress polling (async reindex) |
-### Evaluating Retrieval Quality
-```python
-evaluate_retrieval(test_cases='[
-    {"query": "sql injection", "expected_filepath": "security/sqli-guide.md"},
-    {"query": "privilege escalation", "expected_filepath": "security/privesc.md"}
-]')
-# Returns: MRR@5, Recall@5, per-query results
-```
+**Full API reference with parameter details, return schemas, examples:** [docs/API.md →](docs/API.md)
 ---
-## API Reference
-### Search & Query
+## 🏢 Enterprise Features (built-in, zero configuration)
-#### `search_knowledge`
+Every RAG framework claims "production-ready." Here is what knowledge-rag ships **in the OSS core, verified by regression tests, that competitors either paywall, plugin-ify, or simply don't have.**
-Hybrid search combining semantic search + BM25 keyword search with cross-encoder reranking.
+<table>
+<tr>
+<td valign="top" width="50%">
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `query` | string | required | Search query text (1-3 keywords recommended) |
-| `max_results` | int | 5 | Maximum results to return (1-20) |
-| `category` | string | null | Filter by category |
-| `hybrid_alpha` | float | 0.3 | Balance: 0.0 = keyword only, 1.0 = semantic only |
-| `min_score` | float | 0.0 | Minimum relevance score (0.0-1.0) to include a result. Use 0.2-0.4 to cut noise |
-| `snippet_mode` | bool | true | Truncate content to ~500 chars at natural break points. Adds `content_length` field |
-**Returns:**
-```json
-{
-  "status": "success",
-  "query": "mimikatz credential dump",
-  "hybrid_alpha": 0.5,
-  "result_count": 3,
-  "filtered_by_score": 2,
-  "cache_hit_rate": "0.0%",
-  "results": [
-    {
-      "content": "Mimikatz can extract credentials from memory...",
-      "source": "documents/security/credential-attacks.md",
-      "filename": "credential-attacks.md",
-      "category": "security",
-      "score": 0.9823,
-      "raw_rrf_score": 0.016393,
-      "reranker_score": 0.987654,
-      "semantic_rank": 2,
-      "bm25_rank": 1,
-      "search_method": "hybrid",
-      "keywords": ["mimikatz", "credential", "lsass"],
-      "routed_by": "redteam"
-    }
-  ]
-}
-```
+### Security
-**Search Method Values:**
-- `hybrid`: Found by both semantic and BM25 search (highest confidence)
-- `semantic`: Found only by semantic search
-- `keyword`: Found only by BM25 keyword search
+- **Bearer token auth** on SSE / HTTP transports — constant-time comparison (`hmac.compare_digest`), RFC 6750 challenge, 401 fenced with `WWW-Authenticate` header
+- **Path traversal + symlink escape defenses** — `validate_path_within` guarding 6 CRUD tools (CWE-22, CWE-59)
+- **Prompt injection 3-layer defense** — sentinel neutralization + provenance fence + `external_source` flag (OWASP LLM01:2025)
+- **OpenSSF Best Practices badge** verified · **CodeQL** weekly scan · **Bandit + Semgrep + Gitleaks + pip-audit** on every PR
+- **PyPI Trusted Publishing** via OIDC (zero long-lived tokens in CI)
----
+</td>
+<td valign="top" width="50%">
-#### `get_document`
+### Observability
-Retrieve the full content of a specific document.
+- **Prometheus `/metrics` endpoint** — custom histogram buckets tuned for RAG (p95 ≤ 10ms fast-path targets), 7 canonical metrics via `@instrument` decorator on all 13 tools
+- **Rate limiting** — thread-safe sliding-window counter, per-client RPM + burst, zero overhead when disabled
+- **Health probes** — `GET /health` and `/healthz` returning `{status, version, uptime_seconds, cache}` in front of the auth middleware (probes always succeed)
+- **Structured JSON logging** — opt-in via `server.logging.format: "json"`, one JSON object per record ready for ELK / Loki / Datadog / CloudWatch
+- **Public benchmark dashboard** on GitHub Pages
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `filepath` | string | Path to the document file |
+</td>
+</tr>
+<tr>
+<td valign="top" width="50%">
-**Returns:** JSON with document content, metadata, keywords, and chunk count.
+### Scale & performance
----
+- **SSE / streamable-http transport** — 1 server serves N MCP clients, ChromaDB WAL mode enabled automatically, shared embedding model + query cache
+- **BM25 inverted-index** — **128× faster** than linear scan (custom implementation, replaces `rank-bm25`)
+- **FTS5 SQLite fast-path** (opt-in, ADR-002/003/006/008) — <10ms cold, <2ms hot on lexical queries
+- **Cross-encoder reranking** — Xenova/ms-marco-MiniLM-L-6-v2, +1.88pp Recall@10 (p<0.001)
+- **GPU CUDA 12** with auto DLL discovery + graceful CPU fallback
+- **Query cache** — LRU + 5-min TTL, cuts p95 latency ~40%
+- **Zero-downtime reindex** — staging populate + validation + atomic swap + durable metadata rollback
+- **Async background reindex** with `get_reindex_status()` polling
-#### `reindex_documents`
+</td>
+<td valign="top" width="50%">
-Index or reindex all documents in the knowledge base. **Runs in background** — returns immediately. Poll progress via `get_reindex_status()`.
+### Reliability
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `force` | bool | false | Smart reindex: detects changes, rebuilds BM25. Fast. |
-| `full_rebuild` | bool | false | Nuclear rebuild: deletes everything, re-embeds all documents. Use after model change. |
+- **Nightly chaos injection** — HuggingFace Hub offline · ONNX zero-byte replay · watchdog crash recovery (3 scenarios in `tests/chaos/`)
+- **50 000-iteration soak test** — proves no memory leak after 1h of continuous queries (`KNOWLEDGE_RAG_SOAK_ITERATIONS=50000`)
+- **Mutation testing** (mutmut) on `instance_lock` + `preflight` — catches tests that are too weak
+- **Determinism check** — full test suite × 3, catches flakes
+- **Backwards-compat frozen** — 13 MCP tool parameter names guarded by `tests/test_backwards_compat.py` + legacy YAML fixtures (v3.6.0 / v3.7.0) still parse
+- **API surface AST diff** — `check_api_surface.py` blocks any breaking change at PR time
+- **9-cell CI matrix** — Linux + Windows + macOS × 3.11 + 3.12 + 3.13
-**Returns:** `{"status": "started", "operation": "..."}` immediately. If already running, returns `{"status": "already_running", "progress": "1200/3734"}`.
+</td>
+</tr>
+</table>
 ---
-#### `get_reindex_status`
+## 💼 Use Cases (real corpora, real teams)
-Get the current status of a background reindex operation. Lightweight — does not compute full index statistics.
+### Security Teams — Red / Blue / CTF
-**Returns (active):**
-```json
-{
-  "status": "success",
-  "reindex": {
-    "active": true,
-    "operation": "nuclear_rebuild",
-    "progress": "1200/3734",
-    "percent": 32,
-    "indexed": 1200,
-    "skipped": 0,
-    "errors": 0,
-    "started_at": "2026-06-17T18:29:49"
-  }
-}
-```
+**Preset:** [`cybersecurity.yaml`](presets/cybersecurity.yaml) · 8 categories · 200+ routing keywords · 69 query expansions
-**Returns (idle):** `{"status": "success", "reindex": {"active": false}}`
+Ingest MITRE ATT&CK, threat reports, exploit writeups, incident reports. Search from Claude Code with `search_knowledge("privilege escalation windows")` and get instant recall across your entire corpus. Air-gapped — nothing leaves the laptop.
----
+### Development Teams — Design Docs, Runbooks, Code
-#### `list_categories`
+**Preset:** [`developer.yaml`](presets/developer.yaml) · 9 categories · 150+ routing keywords · 50+ expansions
-List all document categories with their document counts.
+Replace Confluence hunting. Ingest architecture docs, ADRs, runbooks, code, API specs. Devs ask their AI agent "how do we authenticate the payment service" and get the exact ADR + implementation file citation.
-**Returns:**
+### Research Labs — Papers, Notebooks, Datasets
-```json
-{
-  "status": "success",
-  "categories": {
-    "security": 52,
-    "development": 8,
-    "ctf": 12,
-    "general": 3
-  },
-  "total_documents": 75
-}
-```
+**Preset:** [`research.yaml`](presets/research.yaml) · 9 categories · 100+ routing keywords · 40+ expansions
----
+Index arXiv papers, lab notebooks, dataset documentation. Semantic search finds papers by intent, not just keywords — cross-encoder reranking surfaces the actually-relevant one instead of five that share a term.
-#### `list_documents`
+### Enterprise Knowledge Base — Air-gapped, Auditable
-List all indexed documents, optionally filtered by category.
+**Preset:** [`general.yaml`](presets/general.yaml) · blank slate, pure semantic search
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `category` | string | Optional category filter |
+Deploy via SSE on a single VM. 40+ users authenticated via bearer token, rate-limited, Prometheus-monitored, `/health` probes wired to your load balancer, JSON logs shipped to Datadog. No cloud calls. Meets LGPD, GDPR, HIPAA data-locality requirements by design.
-**Returns:** JSON array of documents with id, source, category, format, chunks, and keywords.
+**Verified at scale:** production reproduction on a **5 889-doc / 75 016-chunk corpus** with concurrent queries during a nuclear rebuild — zero downtime, zero errors (see [CHANGELOG v4.8.3](CHANGELOG.md#v483-2026-08-10--critical-hotfix-nuclear-rebuild--smart-reindex-hardening)).
 ---
-#### `get_index_stats`
-Get statistics about the knowledge base index.
+## 🏗️ Architecture at a glance
-**Returns:**
+End-to-end view of how MCP clients, the retrieval pipeline, storage, and enterprise plumbing connect. Every arrow is a real code path — nothing pictured here is aspirational.
-```json
-{
-  "status": "success",
-  "stats": {
-    "total_documents": 75,
-    "total_chunks": 9256,
-    "categories": {"security": 52, "development": 8},
-    "supported_formats": [".md", ".txt", ".pdf", ".py", ".json", ".docx", ".xlsx", ".pptx", ".csv", ".ipynb"],
-    "embedding_model": "BAAI/bge-small-en-v1.5",
-    "embedding_dim": 384,
-    "reranker_model": "Xenova/ms-marco-MiniLM-L-6-v2",
-    "chunk_size": 1000,
-    "chunk_overlap": 200,
-    "query_cache": {
-      "size": 12,
-      "max_size": 100,
-      "ttl_seconds": 300,
-      "hits": 45,
-      "misses": 23,
-      "hit_rate": "66.2%"
-    }
-  }
-}
-```
+```mermaid
+flowchart TB
+    subgraph CLIENTS["MCP Clients (any of these)"]
+        C1[Claude Code]
+        C2[Claude Desktop]
+        C3[Cursor]
+        C4[Windsurf]
+        C5[VS Code · Cline · Gemini CLI · Zed]
+    end
----
+    subgraph TRANSPORT["Transport Layer"]
+        T1[stdio<br/>1 process per client]
+        T2[SSE / streamable-http<br/>1 server serves N clients]
+    end
-### Document Management
+    subgraph MIDDLEWARE["ASGI Middleware Chain (HTTP mode)"]
+        M1[HealthMiddleware<br/>/health · /healthz]
+        M2[BearerAuthMiddleware<br/>constant-time compare]
+        M3[Rate Limiter<br/>sliding window]
+    end
-#### `add_document`
+    subgraph MCP["13 MCP Tools (frozen contract)"]
+        MT1[search_knowledge]
+        MT2[get_document · search_similar]
+        MT3[add_document · add_from_url · update · remove]
+        MT4[reindex_documents · get_reindex_status]
+        MT5[list_documents · list_categories · get_index_stats · evaluate_retrieval]
+    end
-Add a new document to the knowledge base from raw content. Saves the file to the documents directory and indexes it immediately.
+    subgraph SEARCH["Retrieval Pipeline"]
+        R[Query Router<br/>lexical vs semantic]
+        F[FTS5 Fast-Path<br/>opt-in · lt 10ms]
+        BM[BM25 Inverted Index<br/>128x faster than baseline]
+        SE[Semantic Search<br/>FastEmbed ONNX lazy-loaded]
+        RRF[Reciprocal Rank Fusion]
+        CE[Cross-Encoder Rerank<br/>MiniLM-L-6-v2]
+        QC[Query Cache<br/>LRU + 5-min TTL]
+    end
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `content` | string | required | Full text content of the document |
-| `filepath` | string | required | Relative path within documents dir (e.g., `security/new-technique.md`) |
-| `category` | string | "general" | Document category |
+    subgraph STORAGE["Storage (100% local)"]
+        CH[ChromaDB<br/>vectors + metadata<br/>WAL mode]
+        FT[SQLite FTS5<br/>lexical index<br/>WAL + busy-timeout]
+        MD[index_metadata.json<br/>durable state]
+    end
----
+    subgraph INGEST["Document Ingestion"]
+        FS[documents/ folder]
+        WD[Watchdog<br/>10s debounce]
+        PA[35 Parsers<br/>MD · PDF · DOCX · code · IaC · IPYNB]
+        CK[Chunker<br/>markdown-aware · code-aware]
+        EM[FastEmbed ONNX<br/>384D bge-small-en-v1.5]
+        DD[SHA256 Dedup]
+        SW[Zero-downtime Staging Swap<br/>rollback on validation fail]
+    end
-#### `update_document`
+    subgraph OBS["Enterprise Observability (opt-in)"]
+        PM[Prometheus /metrics<br/>7 canonical + histograms]
+        LG[Structured JSON logs<br/>ELK · Loki · Datadog · CloudWatch]
+        HC[Health payload<br/>version · uptime · cache stats]
+    end
-Update an existing document. Removes old chunks from the index and re-indexes with new content.
+    subgraph CFG["Configuration"]
+        YM[config.yaml<br/>+ 5 domain presets]
+    end
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `filepath` | string | Full path to the document file |
-| `content` | string | New content for the document |
+    C1 & C2 & C3 & C4 & C5 -->|MCP protocol| T1
+    C1 & C2 & C3 & C4 & C5 -.->|remote deploy| T2
+    T1 --> MCP
+    T2 --> M1 --> M2 --> M3 --> MCP
+    MT1 --> QC
+    QC -->|cache miss| R
+    R -->|lexical| F
+    R -->|semantic| SE
+    R -->|hybrid| BM
+    F --> CH
+    F --> FT
+    BM --> CH
+    SE --> CH
+    BM --> RRF
+    SE --> RRF
+    RRF --> CE
+    CE --> QC
+    MT2 --> CH
+    MT3 --> INGEST
+    MT4 --> SW
+    MT5 --> CH
+    FS --> WD --> PA
+    PA --> CK --> EM --> DD --> CH
+    SW -.->|atomic swap| CH
+    SW -.-> FT
+    CH -.-> MD
+    MCP -.->|instrumented| PM
+    MCP -.->|logs| LG
+    M1 --> HC
+    YM -.-> SEARCH
+    YM -.-> STORAGE
+    YM -.-> OBS
+    YM -.-> MIDDLEWARE
+    classDef client fill:#3776AB,stroke:#1e5a8a,color:#fff
+    classDef transport fill:#00A67E,stroke:#006e54,color:#fff
+    classDef middleware fill:#6b46c1,stroke:#4c1d95,color:#fff
+    classDef storage fill:#4b5563,stroke:#1f2937,color:#fff
+    classDef obs fill:#dc2626,stroke:#7f1d1d,color:#fff
+    classDef ingest fill:#f59e0b,stroke:#78350f,color:#fff
+    class C1,C2,C3,C4,C5 client
+    class T1,T2 transport
+    class M1,M2,M3 middleware
+    class CH,FT,MD storage
+    class PM,LG,HC obs
+    class FS,WD,PA,CK,EM,DD,SW ingest
+```
+**Reading the diagram (top → bottom):**
+1. **Any MCP client** — Claude Code, Cursor, Windsurf, and 5 others — connects via the transport of your choice (stdio for personal use, SSE/streamable-http for teams).
+2. **HTTP mode chains 3 ASGI middlewares in order**: health probes first (always answered), then bearer auth (fenced with `WWW-Authenticate`), then rate limiter (sliding window).
+3. **All 13 MCP tools** are decorated with `@rate_limited` + `@instrument` — Prometheus counts every call, rate limiter enforces RPM+burst, both zero-cost when disabled.
+4. **`search_knowledge` checks the query cache first**; cache miss routes through the Query Router (regex classifier) to either the FTS5 fast-path (lexical) or the hybrid pipeline (BM25 + semantic + RRF + cross-encoder rerank).
+5. **Storage is 100% local**: ChromaDB (WAL mode) for vectors + metadata, SQLite FTS5 (WAL + busy-timeout) for lexical fast-path, `index_metadata.json` for durable state.
+6. **Document ingestion runs continuously**: watchdog observes `documents/`, 35 parsers handle each format, chunker respects language boundaries, FastEmbed ONNX generates embeddings, SHA256 deduplicates, and a staging swap performs zero-downtime rebuilds with rollback-on-failure.
+7. **Enterprise observability** (opt-in) — Prometheus `/metrics`, structured JSON logs, `/health` payload — attaches to the same instrumentation points, no code changes required.
+8. **`config.yaml` (with 5 domain presets)** controls every subsystem — no environment variable spaghetti, no hardcoded paths.
+**Complete architecture — 4 detailed Mermaid diagrams (System Overview · Query Flow · Document Ingestion · hybrid_alpha effect):** [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)
 ---
-#### `remove_document`
-Remove a document from the knowledge base index. Optionally deletes the file from disk.
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `filepath` | string | required | Path to the document file |
-| `delete_file` | bool | false | If true, also delete the file from disk |
+## 📄 35 File Formats — parsed natively, no plugins needed
+Every parser is **chunk-aware** — Markdown splits at `##` headers, code splits at function/class boundaries, notebooks skip base64 outputs, PDFs use PyMuPDF, spreadsheets extract sheet-by-sheet. **33 formats are enabled by default**; the 2 MetaTrader formats are opt-in (add to `documents.supported_formats` in `config.yaml`).
+| # | Format | Extension | Parser | Default | Notes |
+|---|--------|-----------|--------|:-------:|-------|
+| 1 | Markdown | `.md` | Section-aware (splits at `##`) | Yes | Headers preserved as chunk boundaries |
+| 2 | Plain Text | `.txt` | Fixed-size chunking | Yes | 1000 chars + 200 overlap |
+| 3 | PDF | `.pdf` | PyMuPDF extraction | Yes | Text-based PDFs only (no OCR) |
+| 4 | Word | `.docx` | python-docx | Yes | Headings preserved as markdown |
+| 5 | Excel | `.xlsx` | openpyxl | Yes | Sheet-by-sheet extraction |
+| 6 | PowerPoint | `.pptx` | python-pptx | Yes | Slide-by-slide extraction |
+| 7 | Jupyter Notebook | `.ipynb` | Cell-aware parser | Yes | Markdown + code cells only; skips outputs/base64 |
+| 8 | JSON | `.json` | Structure-aware | Yes | Flattened key-value extraction |
+| 9 | CSV | `.csv` | Row-based parser | Yes | Headers + rows as text |
+| 10 | XML | `.xml` | XML parser | Yes | Root element + namespace metadata |
+| 11 | Python | `.py` | Code-aware parser | Yes | Functions/classes as chunks |
+| 12 | C Source | `.c` | Code-aware parser | Yes | Functions / structs / includes extracted |
+| 13 | C/C++ Header | `.h` | Code-aware parser | Yes | Function declarations + structs extracted |
+| 14 | C++ Source | `.cpp` | Code-aware parser | Yes | Classes / structs / includes extracted |
+| 15 | JavaScript | `.js` | Code-aware parser | Yes | Functions / classes / imports (ESM + CJS) |
+| 16 | React JSX | `.jsx` | Code-aware parser | Yes | Same as JS parser |
+| 17 | TypeScript | `.ts` | Code-aware parser | Yes | Functions / classes / interfaces / enums / imports |
+| 18 | React TSX | `.tsx` | Code-aware parser | Yes | Same as TS parser |
+| 19 | Go | `.go` | Code-aware parser | Yes | Functions / structs / imports extracted |
+| 20 | Rust | `.rs` | Code-aware parser | Yes | Functions / structs / enums / traits / `use` imports |
+| 21 | Kotlin | `.kt` | Code-aware parser | Yes | Functions (incl. class members) / classes extracted |
+| 22 | YAML | `.yaml` | YAML parser | Yes | Kubernetes kind / apiVersion / name extracted |
+| 23 | YAML | `.yml` | YAML parser | Yes | Same as YAML parser |
+| 24 | HuJSON | `.hujson` | HuJSON parser | Yes | JSON with comments + trailing commas (e.g. Tailscale ACLs) |
+| 25 | CUE | `.cue` | Code-aware parser | Yes | Imports / package extracted |
+| 26 | Protocol Buffers | `.proto` | Proto parser | Yes | Services / messages / RPCs extracted |
+| 27 | Rego | `.rego` | Code-aware parser | Yes | OPA policies — imports / package extracted |
+| 28 | SQL | `.sql` | SQL parser | Yes | Table names + statement types extracted |
+| 29 | Shell | `.sh` | Shell parser | Yes | Function names extracted |
+| 30 | jq | `.jq` | Shell parser | Yes | Indexed as shell-style script |
+| 31 | Dockerfile | `Dockerfile` | Text parser | Yes | Matched by exact filename (no extension) |
+| 32 | Makefile | `Makefile` | Text parser | Yes | Matched by exact filename (no extension) |
+| 33 | Tiltfile | `Tiltfile` | Code-aware parser | Yes | Starlark — `def` functions / `load()` extracted |
+| 34 | MQL4 Source | `.mq4` | Code parser | **No** | MetaTrader — opt-in via `documents.supported_formats` |
+| 35 | MQL4 Header | `.mqh` | Code parser | **No** | MetaTrader — opt-in via `documents.supported_formats` |
+> **Enable an opt-in format** — add the extension to `documents.supported_formats` in your `config.yaml`:
+> ```yaml
+> documents:
+>   supported_formats: [".md", ".pdf", ".mq4", ".mqh"]
+> ```
+**Full parser reference with per-format notes:** [docs/CONFIGURATION.md](docs/CONFIGURATION.md)
 ---
-#### `add_from_url`
+## 🔌 Choose your MCP integration
-Fetch content from a URL, strip HTML (scripts, styles, nav, footer, header), convert to markdown, and add to the knowledge base.
+<table>
+<tr>
+<td align="center" width="14%">
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `url` | string | required | URL to fetch content from |
-| `category` | string | "general" | Document category |
-| `title` | string | null | Custom title (auto-detected from `<title>` tag if not provided) |
+**Claude Code**<br/>
+`~/.claude.json`
----
+</td>
+<td align="center" width="14%">
-#### `search_similar`
+**Claude Desktop**<br/>
+`claude_desktop_config.json`
-Find documents similar to a given document using embedding similarity.
+</td>
+<td align="center" width="14%">
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| `filepath` | string | required | Path to the reference document |
-| `max_results` | int | 5 | Number of similar documents to return (1-20) |
+**Cursor**<br/>
+`~/.cursor/mcp.json`
----
+</td>
+<td align="center" width="14%">
-#### `evaluate_retrieval`
+**Windsurf**<br/>
+`~/.codeium/windsurf/mcp_config.json`
-Evaluate retrieval quality with test queries. Useful for tuning `hybrid_alpha`, testing query expansion effectiveness, or validating after reindexing.
+</td>
+<td align="center" width="14%">
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `test_cases` | string (JSON) | Array of test cases: `[{"query": "...", "expected_filepath": "..."}, ...]` |
+**VS Code**<br/>
+Copilot Chat `mcp.json`
-**Metrics:**
-- **MRR@5** (Mean Reciprocal Rank): Average of 1/rank for expected documents. 1.0 = always first result.
-- **Recall@5**: Fraction of expected documents found in top 5 results. 1.0 = all found.
+</td>
+<td align="center" width="14%">
----
-## Configuration
-Knowledge RAG is fully configurable via a `config.yaml` file in the project root. If no `config.yaml` exists, sensible defaults are used — the system works out of the box with zero configuration.
+**Cline · Gemini CLI · Zed**<br/>
+Native MCP
-### Quick Start
+</td>
+</tr>
+</table>
-```bash
-# Option 1: Use a preset
-cp presets/cybersecurity.yaml config.yaml    # Offensive/defensive security, CTFs
-cp presets/developer.yaml config.yaml        # Software engineering, APIs, DevOps
-cp presets/research.yaml config.yaml         # Academic research, papers, studies
-cp presets/general.yaml config.yaml          # Blank slate, pure semantic search
-# Option 2: Start from the documented template
-cp config.example.yaml config.yaml
-# Edit config.yaml to your needs
-```
+**Complete client configuration guide with JSON schemas per client:** [docs/INSTALLATION.md#use-with-other-mcp-clients →](docs/INSTALLATION.md#use-with-other-mcp-clients)
-Restart Claude Code after changing `config.yaml`.
+---
-### config.yaml Structure
+## ⚙️ Configuration in 30 seconds
 ```yaml
-# Paths — where your documents live
+# config.yaml — everything is optional; defaults just work
 paths:
-  documents_dir: "./documents"    # Scanned recursively
-  data_dir: "./data"              # Index storage
-  models_cache_dir: "./models_cache"  # Persistent embedding model cache
-# Documents — what gets indexed and how
-documents:
-  supported_formats:              # File types to index
-    - .md
-    - .txt
-    - .pdf
-    - .docx
-    - .ipynb
-    # - .py                       # Uncomment to index code
-  exclude_patterns:               # Glob patterns to skip
-    - "node_modules"
-    - ".venv"
-    - "__pycache__"
-  chunking:
-    chunk_size: 1000              # Max chars per chunk
-    chunk_overlap: 200            # Shared chars between chunks
-# Models — AI models for search (all run locally, no API keys)
+  documents_dir: "./documents"
+  data_dir: "./data"
 models:
   embedding:
-    model: "BAAI/bge-small-en-v1.5"   # ONNX, ~33MB, auto-downloaded
-    dimensions: 384
-    gpu: false                         # Set true + pip install knowledge-rag[gpu]
+    profile: "compact"                  # "compact" | "quality" | "multilingual" | "custom"
+    gpu: "auto"                         # "auto" | "true" | "false"
   reranker:
-    enabled: true                      # Falls back to RRF if model is unavailable
-    model: "Xenova/ms-marco-MiniLM-L-6-v2"
-    top_k_multiplier: 3               # Candidates fetched before reranking
+    enabled: true                       # cross-encoder rerank
-# Search — result limits and collection name
 search:
   default_results: 5
-  max_results: 20
-  collection_name: "knowledge_base"   # Change for separate knowledge bases
-# Categories — auto-tag documents by folder path
-# Set to {} to disable categorization entirely
-category_mappings:
-  "security/redteam": "redteam"
-  "security/blueteam": "blueteam"
-  "notes": "notes"
-# Keyword routing — prioritize categories based on query keywords
-# Set to {} for pure semantic search with no routing bias
-keyword_routes:
-  redteam:
-    - pentest
-    - exploit
-    - privilege escalation
-# Query expansion — expand abbreviations for better BM25 recall
-# Set to {} for no expansion (search terms used as-is)
-query_expansions:
-  sqli:
-    - sql injection
-    - sqli
-  privesc:
-    - privilege escalation
-    - privesc
-# Server — enterprise features (new in v4.0.0)
-server:
-  transport: "stdio"              # "stdio" | "sse" | "streamable-http"
-  host: "127.0.0.1"              # Bind address (SSE/HTTP only)
-  port: 8179                      # Bind port (SSE/HTTP only)
+  max_results: 100
+server:                                 # optional — SSE / HTTP mode
+  transport: "stdio"                    # or "sse" / "streamable-http"
   auth:
-    bearer_token: ""              # Set a secret to enable auth (SSE/HTTP only)
+    bearer_token: ""                    # set a secret to enable auth
   rate_limit:
     enabled: false
-    requests_per_minute: 60
-    burst: 10
   metrics:
     enabled: false
-    port: 9179                    # Separate port for Prometheus scraping
-```
-> See `config.example.yaml` for the fully documented template with explanations for every field.
-### Presets
-Pre-built configurations for common use cases:
-| Preset | File | Categories | Keywords | Expansions | Best For |
-|--------|------|-----------|----------|-----------|----------|
-| **Cybersecurity** | `presets/cybersecurity.yaml` | 8 | 200+ | 69 | Red/Blue Team, CTFs, threat hunting, exploit dev |
-| **Developer** | `presets/developer.yaml` | 9 | 150+ | 50+ | Full-stack dev, APIs, DevOps, cloud, databases |
-| **Research** | `presets/research.yaml` | 9 | 100+ | 40+ | Academic papers, thesis, lab notebooks, datasets |
-| **General** | `presets/general.yaml` | 0 | 0 | 0 | Blank slate — pure semantic search, no domain logic |
-**Creating your own preset**: Copy `config.example.yaml`, fill in your categories/keywords/expansions, save to `presets/your-domain.yaml`.
-### Configuration Reference
-#### Server
-| Field | Default | Description |
-|-------|---------|-------------|
-| `server.transport` | `"stdio"` | Transport protocol: `"stdio"`, `"sse"`, or `"streamable-http"` |
-| `server.host` | `"127.0.0.1"` | Bind address for SSE/HTTP mode |
-| `server.port` | `8179` | Bind port for SSE/HTTP mode |
-| `server.auth.bearer_token` | `""` (disabled) | Bearer token for SSE/HTTP auth. Empty = no auth |
-| `server.rate_limit.enabled` | `false` | Enable per-client rate limiting |
-| `server.rate_limit.requests_per_minute` | `60` | Max requests per minute |
-| `server.rate_limit.burst` | `10` | Burst allowance above steady rate |
-| `server.metrics.enabled` | `false` | Enable Prometheus `/metrics` endpoint |
-| `server.metrics.port` | `9179` | Port for metrics scraping |
-In stdio mode (default), server settings are ignored. SSE/HTTP mode auto-enables the single-instance lock.
-#### Paths
-| Field | Default | Description |
-|-------|---------|-------------|
-| `paths.documents_dir` | `./documents` | Root folder scanned recursively for documents |
-| `paths.data_dir` | `./data` | Internal storage for ChromaDB and index metadata |
-| `paths.models_cache_dir` | `./models_cache` | Persistent cache for embedding models (~250MB). Survives reboots |
-Relative paths resolve from the project root. Absolute paths work too.
-#### Documents
-| Field | Default | Description |
-|-------|---------|-------------|
-| `documents.supported_formats` | .md .txt .pdf .py .json .docx .xlsx .pptx .csv .ipynb | File extensions to index |
-| `documents.exclude_patterns` | `[]` (empty) | Glob patterns for files/dirs to skip during indexing |
-| `documents.chunking.chunk_size` | 1000 | Max characters per chunk |
-| `documents.chunking.chunk_overlap` | 200 | Characters shared between consecutive chunks |
-**Chunking guidelines**: Short notes → 500/100. General use → 1000/200. Long technical docs → 1500/300.
-For `.md` files, chunking splits at `##` and `###` header boundaries first. Sections larger than `chunk_size` are sub-chunked with overlap. Non-markdown files use fixed-size chunking.
-#### Models
-| Field | Default | Description |
-|-------|---------|-------------|
-| `models.embedding.model` | `BAAI/bge-small-en-v1.5` | Embedding model (ONNX, runs locally) |
-| `models.embedding.dimensions` | 384 | Vector dimensions (must match model) |
-| `models.embedding.gpu` | false | Enable CUDA GPU acceleration. See [GPU Acceleration](#gpu-acceleration) for full setup |
-| `models.reranker.enabled` | true | Enable cross-encoder reranking |
-| `models.reranker.model` | `Xenova/ms-marco-MiniLM-L-6-v2` | Reranker model |
-| `models.reranker.top_k_multiplier` | 3 | Fetch N*multiplier candidates for reranking |
-If the reranker model is not available locally and the machine cannot download it, search now falls back to the RRF order from hybrid semantic+BM25 retrieval. This keeps `search_knowledge` available offline, but result ordering may be less precise for ambiguous queries until the reranker model is cached.
-**Embedding model options** (fastest → most accurate):
-- `BAAI/bge-small-en-v1.5` — 384D, ~33MB (default)
-- `BAAI/bge-base-en-v1.5` — 768D, ~130MB
-- `BAAI/bge-large-en-v1.5` — 1024D, ~335MB
-- `intfloat/multilingual-e5-small` — 384D, 100+ languages
-> **Warning**: Changing the embedding model after indexing requires `reindex_documents(full_rebuild=True)`.
-#### Search
-| Field | Default | Description |
-|-------|---------|-------------|
-| `search.default_results` | 5 | Results returned when no limit specified |
-| `search.max_results` | 20 | Hard cap even if client requests more |
-| `search.collection_name` | `knowledge_base` | ChromaDB collection — change for separate KBs |
-#### Categories
-Map folder paths to category names. Documents in matching folders get auto-tagged, enabling filtered searches.
-```yaml
-category_mappings:
-  "security/redteam": "redteam"
-  "security": "security"
-```
-Set `category_mappings: {}` to disable — documents are still searchable, just without category filters.
-#### Keyword Routing
-Route queries to categories based on keywords. When a query contains listed keywords, results from that category are prioritized (not filtered — other categories still appear, ranked lower).
-```yaml
-keyword_routes:
-  redteam:
-    - pentest
-    - exploit
-    - sqli
+  logging:
+    format: "text"                      # or "json"
 ```
-Single-word keywords use regex word boundaries (`\b`) — "api" won't match "RAPID". Multi-word keywords use substring matching.
-Set `keyword_routes: {}` for pure semantic search.
-#### Query Expansion
-Expand search terms with synonyms before BM25 search. Supports single tokens, bigrams, and full query matches.
-```yaml
-query_expansions:
-  sqli:
-    - sql injection
-    - sqli
-  k8s:
-    - kubernetes
-    - k8s
-```
+**Pre-built presets:** [`cybersecurity.yaml`](presets/cybersecurity.yaml) · [`developer.yaml`](presets/developer.yaml) · [`research.yaml`](presets/research.yaml) · [`general.yaml`](presets/general.yaml) · [`multilingual.yaml`](presets/multilingual.yaml)
-Set `query_expansions: {}` for no expansion.
+**Complete configuration reference — every field, every default, tuning guide:** [docs/CONFIGURATION.md →](docs/CONFIGURATION.md)
-`query_expansions` is directional: only the key on the left triggers the terms on the right. If you need mutual expansion without duplicating entries, use `query_expansion_groups`.
-```yaml
-query_expansion_groups:
-  - ["triple barrier", "tb", "trip_barr"]
-  - ["profit factor", "pf"]
-```
-Each group is interpreted symmetrically, so every term expands to the rest of the group. The final internal expansion table is built by merging both sources:
+---
-1. `query_expansions` entries are loaded as-is.
-2. `query_expansion_groups` adds reciprocal links for every term in each group.
-3. Overlaps are merged by union with duplicate terms removed.
+## 🔒 Security & Compliance
-This keeps backward compatibility while allowing concise synonym groups.
+knowledge-rag is designed for teams that cannot let their documents leave the perimeter.
-### Hybrid Search Tuning
+| Requirement | How knowledge-rag delivers |
+|---|---|
+| **Data locality (LGPD / GDPR / HIPAA)** | 100% on-premise, zero egress network calls after initial model download |
+| **Air-gapped deployment** | ONNX models pre-cached; set `HF_HUB_OFFLINE=1` to enforce zero-network |
+| **CVE monitoring** | Dependabot (weekly) + pip-audit + Socket + CodeQL |
+| **Supply chain security** | PyPI Trusted Publishing via OIDC (no long-lived tokens) |
+| **Vulnerability disclosure** | Private security advisory via [SECURITY.md](SECURITY.md) |
+| **Signed release attestations** | GitHub release attestations on every published version |
+| **Reproducible builds** | Locked `requirements.txt` with pinned versions |
+| **Authenticated access** | Bearer token middleware on SSE / HTTP transports (constant-time compare, RFC 6750) |
+| **Rate limiting** | Sliding-window per-client RPM + burst (opt-in, zero-cost when disabled) |
+| **Audit-ready logging** | Opt-in structured JSON logs → ship to your SIEM |
+| **Path traversal defenses** | CWE-22 / CWE-59 guards on 6 CRUD tools |
+| **Prompt injection defense** | 3-layer sanitization on `add_from_url` (OWASP LLM01:2025) |
-| hybrid_alpha | Behavior | Best For |
-|--------------|----------|----------|
-| 0.0 | Pure BM25 keyword | Exact terms, CVEs, tool names |
-| 0.3 | Keyword-heavy **(default)** | Technical queries with specific terms |
-| 0.5 | Balanced | General queries |
-| 0.7 | Semantic-heavy | Conceptual queries, related topics |
-| 1.0 | Pure semantic | "How to..." questions, abstract concepts |
+**OpenSSF Best Practices** badge: passing · project ID [#13864](https://bestpractices.coreinfrastructure.org/projects/13864)
-### Search Method (v4.8.2+)
+---
-Two paths ship with v4.8.2 — the default `hybrid` path (BM25 + semantic + RRF
-+ optional rerank) that has been the sole path since v4.0, and an opt-in
-`fts5` lexical fast-path optimised for exact identifier queries (CVEs, MITRE
-ATT&CK codes, CWEs, file hashes, bug-bounty IDs). Enable via
-`search.lexical_fast_path.enabled: true` in `config.yaml`.
+## 📈 Numbers that matter
-| Method                  | Path              | Latency (typical)     | Best For                                     |
-|-------------------------|-------------------|-----------------------|----------------------------------------------|
-| `auto` **(default)**    | Router decides    | Router adds ~0.1ms    | Mixed workloads — safe default               |
-| `hybrid`                | BM25 + semantic   | 50-150ms (with rerank)| Prose queries, "how does X work", exploration|
-| `fts5`                  | SQLite FTS5 only  | <10ms cold / <2ms hot | CVE / MITRE / CWE / hash lookups             |
+- **26 000+** total downloads on PyPI · **250+** GitHub stars · **70+** enterprise teams (private + community)
+- **700+ tests** collected · **1.33:1** test-to-code ratio · **codecov trend gate** ±0.5pp
+- **35+ status checks** on every PR (9-cell OS×Python matrix · 7 quality pillars)
+- **35 file formats** parsed natively · **13 MCP tools** frozen · **5 domain presets** (cyber · dev · research · multilingual · general)
+- **BM25 128× faster** than baseline · **cross-encoder +1.88pp** Recall@10 (p<0.001) · **cache −40%** p95 latency
+- **1 800+ files / 39 K chunks indexed in < 3 min** on a modern laptop (typical developer corpus)
+- **Verified in production** on 5 889-doc / 75 016-chunk corpora
-The `search_knowledge` MCP tool exposes `search_method: Literal["auto",
-"hybrid", "fts5"] = "auto"` (ADR-006, additive on the LEI 1 contract). The
-default `enabled: false` preserves v4.8.1 behaviour byte-for-byte; the flip
-to `enabled: true` by default is reserved for v4.9.0 pending the CI
-perf-gate adjudication documented in ADR-004 and ADR-009. Full user guide
-in [`docs/features/fts5_fast_path.md`](docs/features/fts5_fast_path.md).
+**Public benchmark dashboard:** https://lyonzin.github.io/knowledge-rag/
 ---
-## Project Structure
-```
-knowledge-rag/
-├── mcp_server/
-│   ├── __init__.py          # Stdout protection + version
-│   ├── config.py            # YAML config loader + defaults
-│   ├── ingestion.py         # 20 parsers, chunking, metadata extraction
-│   └── server.py            # MCP server, ChromaDB, BM25, reranker, 12 tools
-├── config.example.yaml      # Documented config template (copy to config.yaml)
-├── config.yaml              # Your active configuration (git-ignored)
-├── presets/                  # Ready-to-use domain configurations
-│   ├── cybersecurity.yaml
-│   ├── developer.yaml
-│   ├── research.yaml
-│   └── general.yaml
-├── documents/               # Your documents (scanned recursively)
-├── data/
-│   ├── chroma_db/           # ChromaDB vector database
-│   └── index_metadata.json  # Incremental indexing state
-├── models_cache/            # Persistent embedding model cache
-├── tests/                   # Test suite (82 tests)
-├── install.sh               # Linux/macOS installer
-├── install.ps1              # Windows installer
-├── venv/                    # Python virtual environment
-├── requirements.txt
-├── pyproject.toml
-├── LICENSE
-└── README.md
-```
+## 📚 Documentation
+| Doc | What's inside |
+|---|---|
+| [**Installation guide**](docs/INSTALLATION.md) | 5 install methods · 8 MCP client integrations · GPU setup |
+| [**API reference**](docs/API.md) | Complete reference for all 13 MCP tools |
+| [**Configuration reference**](docs/CONFIGURATION.md) | Every `config.yaml` field · presets · tuning |
+| [**Architecture**](docs/ARCHITECTURE.md) | 4 Mermaid diagrams: System Overview · Query Flow · Ingestion · hybrid_alpha |
+| [**Troubleshooting**](docs/TROUBLESHOOTING.md) | 11 common issues + solutions |
+| [**FTS5 fast-path guide**](docs/features/fts5_fast_path.md) | Opt-in lexical fast-path — when and how |
+| [**Reindex operations**](docs/reindex-operations.md) | Zero-downtime rebuild · resume · checkpoint |
+| [**GPU setup**](docs/gpu-setup.md) | CUDA 12 installation + troubleshooting |
+| [**Migration to v4.8.0**](docs/migration-v4.8.0.md) | Embedding profile · multilingual · zero-downtime |
+| [**Security policy**](SECURITY.md) | Threat model · disclosure channel |
+| [**Contributing**](CONTRIBUTING.md) | Development · testing · PR process |
+| [**Changelog**](CHANGELOG.md) | All release notes since v1.0.0 |
 ---
-## Troubleshooting
-### Python version mismatch
-Requires Python 3.11 or newer.
-```bash
-python --version    # Must be 3.11+
-```
-### FastEmbed model download fails
-On first run, FastEmbed downloads models to `models_cache/`. If the download fails:
-```bash
-# Clear cache and retry
-# Windows:
-rmdir /s /q models_cache
-# Linux/macOS:
-rm -rf models_cache
-# Then restart the MCP server
-```
-### Reranker model download fails
-The reranker is lazy-loaded on the first query. If the model is not cached and the machine is offline, search continues without reranking and uses the RRF order from hybrid retrieval. To keep reranking enabled offline, run one query while online or pre-populate `models_cache/` on the target machine.
-You can still disable reranking explicitly in `config.yaml`:
-```yaml
-models:
-  reranker:
-    enabled: false
-```
-Disabling reranking reduces memory use and avoids first-query model loading. The tradeoff is lower ranking precision, especially when several chunks match the same terms but only one is the best answer.
-### ChromaDB index crashes on startup
-Native ChromaDB failures can terminate Python before normal exception handling runs. Startup now probes ChromaDB in a child process before initializing the MCP server. If the probe crashes, the active `chroma_db/` and `index_metadata.json` are moved to `data/backups/auto-repair-*`, and the next startup can rebuild a clean index.
-The same guarded behavior is available through either console script:
-```bash
-knowledge-rag
-knowledge-rag-guarded
-```
-### Index is empty
-```bash
-# Check documents directory has files
-ls documents/
-# Force reindex via Claude Code:
-# reindex_documents(force=True)
-# Or nuclear rebuild if model changed:
-# reindex_documents(full_rebuild=True)
-```
-### MCP server not loading
-1. Check `~/.claude.json` exists and has valid JSON in the `mcpServers` section
-2. Verify paths use double backslashes (`\\`) on Windows
-3. Restart Claude Code completely
-4. Run `claude mcp list` to check connection status
+## 🤝 Community & Support
-### "Failed to connect" error
+- **Report a bug** → [Open an issue](https://github.com/lyonzin/knowledge-rag/issues/new/choose)
+- **Ask a question** → [GitHub Discussions](https://github.com/lyonzin/knowledge-rag/discussions)
+- **Report a vulnerability** → [Security advisory](https://github.com/lyonzin/knowledge-rag/security/advisories/new) (private)
+- **Contribute** → [CONTRIBUTING.md](CONTRIBUTING.md)
-The MCP server uses stdout for JSON-RPC communication. If a library prints to stdout during init, the stream gets corrupted. v3.4.3+ includes stdout protection that prevents this. If you're on an older version, upgrade:
-```bash
-pip install --upgrade knowledge-rag
-```
-### Slow first query
-The cross-encoder reranker model is lazy-loaded on the first query. This adds a one-time ~2-3 second delay for model download and loading. Subsequent queries are fast. If the model cannot be loaded, search falls back to RRF ordering and does not retry loading the reranker until the server restarts.
-### Memory usage
-With ~200 documents, expect ~300-500MB RAM. The embedding model (~200MB ONNX runtime resident, lazy-loaded on first query since v3.8.0) and reranker (~25MB, lazy-loaded) are loaded into memory only when actually used. For very large knowledge bases (1000+ documents), consider enabling GPU acceleration and using exclude patterns to limit index scope.
-### Multiple MCP clients spawn duplicate servers
-MCP stdio is one process per client by protocol — multiple Claude Code windows, Claude Desktop + IDE, etc. each spawn their own `knowledge-rag` process. Since v3.8.0 idle processes are cheap (no embedding model loaded until first query). If you've measured and want a hard cap of one server per data directory, opt in:
-```bash
-export KNOWLEDGE_RAG_SINGLE_INSTANCE=1
-```
-A second instance exits immediately with code 75. Default is OFF (multi-client friendly). Full guide: [docs/single-instance.md](docs/single-instance.md). Sample MCP config: [examples/mcp-config-single-instance.json](examples/mcp-config-single-instance.json).
-### SSE server won't start
-```bash
-# Check if port 8179 is already in use
-# Windows:
-netstat -aon | findstr :8179
-# Linux/macOS:
-lsof -i :8179
-```
-If `uvicorn` is not found, install the server extras: `pip install knowledge-rag[server]`
-### Can't connect to SSE server
-Verify the server is running and the URL is correct:
-```bash
-curl http://127.0.0.1:8179/sse
-```
-Common issues:
-- Wrong URL: must end with `/sse` (not just the port)
-- Firewall blocking the port
-- Server started with a different host/port than configured in the MCP client
+**Response SLA (best-effort, community project):**
+- Security reports: within 48 h
+- Bug reports with reproduction: within 5 business days
+- Feature requests: triaged on next release cycle
 ---
-## Changelog
-### Unreleased
-### v4.8.4 (2026-08-13) — Patch: security + durability + defensive fixes
-**Recommended upgrade for anyone running HTTP/SSE transport with bearer auth on a non-loopback host, or relying on `reindex_documents(force=True)`.** Four independent fixes accumulated since v4.8.3: one previously blocked remote-with-auth deployments (#174), one silently corrupted durable index metadata after a failed rebuild (#173), and two defensive fixes hardened `.ipynb` ingestion (#175) and the nightly chaos suite (#164).
-**Fixed:**
-- **fix(security)** — create the HTTP MCP app with the configured `server_host`. On the bearer-auth path the app factory was called without a host, so it defaulted to `127.0.0.1` and MCP 2.0.0's localhost-only DNS-rebinding allowlist rejected a configured non-loopback host with `421 Invalid Host header` before auth ran — even though uvicorn was bound to that host. Remote/LAN deployments with auth are now reachable (#174).
-- **fix(reindex)** — restore durable metadata on a failed zero-downtime rebuild. The staging populate path persisted the staging map to `index_metadata.json` before validation ran; when validation failed, rollback restored only the in-memory `_indexed_docs`, leaving the file describing staging while memory held production. After a restart `_load_metadata` trusted the stale file, corrupting skip/update and embedding-dimension decisions. Rollback now re-persists the restored production metadata (#173).
-- **fix(ingestion)** — `_parse_ipynb` handled invalid JSON gracefully but then assumed the parsed notebook was a well-formed dict. A valid-JSON notebook with a null `metadata` or `cells` field, a non-dict cell, a bare list, or a dict cell whose `source` is not `str | list[str]` (a number, a dict, or a list with non-string items) crashed with `AttributeError`/`TypeError`. Guarded the notebook, `metadata`, `cells`, cell, and cell `source` lookups so a parseable-but-malformed notebook is handled the same as any other odd input (#175, thanks @eeshsaxena).
-- **fix(ci)** — the nightly chaos job (`pytest -m chaos`) aborted collection with `ModuleNotFoundError: No module named 'hypothesis'` because `tests/test_query_router.py` imported hypothesis at module top-level while the chaos job installs only `pytest psutil numpy`. Guarded the import with `pytest.importorskip("hypothesis")` so the module is skipped cleanly instead of failing the whole nightly run (#164).
-**Docs:**
-- **docs(architecture)** — sync the 4 Mermaid diagrams in `## Architecture` (System Overview, Query Processing Flow, Document Ingestion Flow, hybrid_alpha Parameter Effect) with the v4.8.2 FTS5 fast-path (ADR-002/003/006), the v4.8.3 `_write_collection` staging dispatcher (#161), and the current 8-category layout. The diagrams previously described only the pre-v4.8 hybrid pipeline and 4-category storage; they now also show FTS5 dispatch, fallback semantics, FTS5 CRUD sync (ADR-008), and the zero-downtime staging write path. `hybrid_alpha` now clarifies that the fast-path bypasses RRF entirely so the weighting only matters on the hybrid path.
-**No breaking changes.** Backwards compat verified by `check_api_surface.py` (zero diff vs baseline). All 13 MCP tool parameter names frozen (verified by `tests/test_backwards_compat.py`).
-### v4.8.3 (2026-08-10) — Critical hotfix: nuclear-rebuild + smart-reindex hardening
-**Recommended upgrade for any corpus with >1000 chunks or any user relying on `reindex_documents(force=True)` after a config change.** The v4.8.0 nuclear rebuild + v4.8.2 FTS5 fast-path have several latent state-management bugs that only trigger under a real-world combination (large corpus + rebuild + concurrent queries + FTS5 opt-in). Enterprise users with hacktricks-scale corpora (~50k+ chunks) are affected.
-Fixes 3 GitHub issues opened by @grishkovei against v4.8.1:
-- **Fixes #161** — `_rebuild_via_swap()` no longer rebinds `self.collection` to the empty staging collection during populate. Writes now route through the new `_write_collection` property (returns `self._staging_target` when set, else production). Queries keep reading `self.collection` unchanged. Zero-downtime is now real, not just a docs promise. `nuclear_rebuild(swap=True)` on 50k-chunk corpora previously served empty results for the entire hours-long populate window; queries now hit production until the atomic swap completes.
-- **Fixes #162** — Smart-reindex checkpoint now serializes only doc-ids the current run actually committed (via new `tracking["committed_this_run"]` set), not the full `_indexed_docs.keys()` snapshot. A document that changed on disk before the reindex reached it is no longer silently skipped on resume — its mtime/size delta is properly detected.
-- **Fixes #163** — `reindex_documents(force=True)` now propagates through to `index_all(force=True)`. The v4.8 migration path (`docs/migration-v4.8.0.md`) documented `force=True` as the way to re-embed after prefix/model changes; the hardcoded `force=False` in `reindex_all()` silently skipped every unchanged file. Prefix-only changes no longer leave mixed old/new embedding conventions.
-Additional fixes discovered while triaging production issues on a 5889-doc / 75016-chunk corpus:
-- **fix(indexing)** — `_index_lock` moved from class-level to instance-level (`__init__`). The class-level `threading.Lock` was silently shared across all `KnowledgeOrchestrator` instances, so a staging orchestrator from a previous `nuclear_rebuild` swap could be garbage-collected while holding the lock, leaving every subsequent `reindex_documents` returning `reindex_already_running` despite `active: false`. Requires daemon restart to recover pre-fix.
-- **fix(chromadb)** — `_ensure_bm25_initialized` and `_iter_chroma_chunks_for_fts5` now batch-read Chroma via `offset+limit=500` instead of `collection.get(limit=count)`. Chromadb 1.x rebuilds an `IN (?, ?, ...)` clause per returned row, so a single `limit=48184` call blew past SQLite's default `max_variable_number=999` with `Internal error: too many SQL variables`. Any user with >999 chunks who ran nuclear rebuild or triggered the FTS5 lazy migration got a silently failed rebuild.
-- **fix(fts5)** — `Fts5LexicalIndex.is_ready()` now re-reads the marker file when the cached `_ready` is False. Previously an orchestrator instantiated during nuclear-swap while the FTS5 migration was still running cached `_ready=False` forever and never re-checked the marker, permanently silencing the fast-path.
-- **fix(fts5)** — `_maybe_start_fts5_migration` cross-checks FTS5 row count vs Chroma count on startup. A stale `complete` marker paired with a near-empty FTS5 index (post-swap orphan cleanup, manual truncate, disk corruption) previously left the fast-path silent forever. The new `_fts5_marker_matches_reality` helper triggers rebuild when FTS5 holds less than 10% of Chroma's row count.
-- **fix(fts5)** — `_format_fts5_results` skips orphan hits (FTS5 has the `chunk_id` but Chroma doesn't — nuclear-rebuild residue or manual-delete race). Previously emitted empty result items with `source=""` that broke reranking and polluted result lists.
-- **fix(indexing, config)** — Added `Fts5LexicalIndex.count()` for the new sanity check.
-All 6 core fixes were confirmed via production reproduction on a 75016-chunk corpus + 2052 newly-added catalog documents; the `nuclear_rebuild(full_rebuild=True)` path now completes cleanly and populates FTS5 with 75016 rows on first attempt.
-Migration path: `pip install -U knowledge-rag==4.8.3` (or `npx -y knowledge-rag@4.8.3` / `docker pull ghcr.io/lyonzin/knowledge-rag:4.8.3`) then restart the MCP daemon. No config changes required. If your FTS5 index is corrupted from a prior partial rebuild (marker says `complete` but queries return empty), delete `data/fts5_migration.state` and restart — the daemon will detect the drift and rebuild automatically.
-### v4.8.2 (2026-08-10) — FTS5 Lexical Fast-Path Opt-In Release (default OFF)
-v4.8.2 bundles Fases 1–5 of the FTS5 Lexical Fast-Path plan
-(`.compozy/tasks/fts5-lexical-fast-path/`) as an **opt-in** release —
-`search.lexical_fast_path.enabled` remains `false` by default, so users
-who do not touch `config.yaml` keep v4.8.1 behaviour byte-for-byte
-(LEI 1 preserved). The v4.9.0 default flip is deferred to the CI
-perf-gate adjudication documented in ADR-009 (bench harness ships in
-this release; the flip PR follows once G1 ≥15× and G2 ≤2% both pass on
-CI hardware).
-- **DOCS (search)**: new `docs/features/fts5_fast_path.md` user guide
-  covering overview / quick-start / 5-key config reference / how it
-  works / 5 troubleshooting scenarios / when-to-use guidance. README
-  Configuration section cross-links it.
-- **NEW (bench)**: `bench/test_bench_fts5_lexical.py` ships the
-  BENCH-001 (cold, p95 ≤ 10ms target) + BENCH-002 (hot, p95 ≤ 2ms
-  target) harness against a self-contained 3865-row FTS5 corpus. The
-  gate G2 comparison against `bench/test_bench_search.py` is executed
-  by CI per `.compozy/tasks/fts5-lexical-fast-path/bench_v4_9_0_gate.md`;
-  the two-round A/B was not run locally because the release-authoring
-  workstation cannot fairly baseline against CI hardware (ADR-004
-  §Risks).
-- **DOCS (adr)**: new ADR-009 documenting why the ADR-004 gate is
-  deferred to the CI perf-gate step and what conditions unlock the
-  v4.9.0 flip PR.
-- **CHANGE (config)**: `config.example.yaml` uncomments the
-  `search.lexical_fast_path.*` block so new users see the full
-  configuration surface (still `enabled: false`). Existing installs
-  are unaffected.
-- **VERSION**: 4.8.1 → **4.8.2** (PATCH — opt-in infrastructure + docs,
-  zero behaviour change on the default install).
-- **feat (search)**: FTS5 lazy background migration for existing corpus + CRUD sync (ADR-008). `Fts5LexicalIndex` gains `add_document`/`update_document`/`remove_document` (SQL INSERT/DELETE under `_fts5_lock`, incremental — diverges from BM25's full-rebuild pattern because FTS5 mutations are O(1) native SQL) and `start_migration_background(chunk_iter_factory, docs_total, resume_from=0, on_progress=...)` (daemon thread that persists checkpoint every 100 rows into the marker file). On daemon startup, `_maybe_start_fts5_migration` reads the marker: `complete` = fast-path live, `in_progress` = resume from `docs_indexed`, `failed`/missing = start fresh migration; queries during migration fall back to hybrid + emit `fast_path_fallback_total{reason="disabled"}`. `KnowledgeOrchestrator.{add,update,remove}_document_*` gain best-effort FTS5 sync hooks after the BM25 rebuild — errors are caught, logged, and counted (`fast_path_errors_total{error_class="Fts5CrudSyncError"}`) but never propagate to the CRUD tool (upstream write must keep succeeding). `nuclear_rebuild` and `_rebuild_bm25_post_swap` drop the FTS5 db + WAL/SHM/marker and dispatch a fresh migration from the swapped-in Chroma corpus. Two Prometheus gauges expose migration progress (`knowledge_rag_fast_path_migration_docs_indexed`, `_docs_total`). Standalone rebuild helper `scripts/build_fts5_index.py --data-dir <path> [--force] [--foreground] [--verbose]` for operator-driven repair. Operational runbook in `docs/runbooks/fts5_migration.md` covering enable / wait / verify / manual rebuild / large-corpus caveat. New coverage: `tests/test_fts5_migration.py` (17 tests — TestMigrationLifecycle UT-043..048, TestCRUDSync UT-049..052, TestMigrationIntegration IT-021..023, TestCRUDSyncIntegration IT-CRUD-001..004) + `tests/test_e2e_fts5.py::test_e2e006_forced_fts5_with_migration_pending_raises` (E2E-006). Fase 4 of the FTS5 Lexical Fast-Path plan.
-- **NEW (search)**: Optional cross-encoder rerank toggle on the FTS5 fast-path via `search.lexical_fast_path.rerank_enabled` (default `false` — see ADR-003 for rationale). When `true`, `KnowledgeOrchestrator._run_fts5_search` layers `CrossEncoderReranker.rerank` on top of the FTS5 results before adjacent-chunk expansion; result items keep `search_method="fts5"` (rerank is a rescorer, not a path change) and `reranker_score` is populated. When `false`, the `knowledge_rag_fast_path_rerank_skipped_total` counter increments and the fast-path stays under the <10ms lexical latency budget. Empirical basis: Flash-Rerank MiniLM-L-6-v2 CPU ≈72ms/100 docs vs the <10ms target — keeping rerank OFF by default is the correct trade-off; opt in only when recall on lexical queries matters more than latency. New coverage: `tests/test_search.py::TestRerankToggle` (UT-062, UT-063, IT-024, IT-025). Fase 3.5 of the FTS5 Lexical Fast-Path plan.
-- **NEW (search)**: FTS5 lexical fast-path dispatch wired inside `KnowledgeOrchestrator.query()` behind the opt-in `search.lexical_fast_path.enabled` toggle (default `false` — v4.8.1 behavior byte-for-byte for users who don't touch config). When enabled, the query router (Fase 2) classifies each query; lexical queries dispatch to the FTS5 index (Fase 1) via a new `_maybe_dispatch_fts5` helper, semantic queries flow through the existing hybrid pipeline. Per ADR-003 the cross-encoder reranker is skipped on the fast-path (real opt-in toggle deferred to Task 04). Per ADR-006 the `search_knowledge` MCP tool gains one optional param `search_method: Literal["auto","hybrid","fts5"] = "auto"` — additive-safe on the LEI 1 backward-compat contract. Explicit `"fts5"` when the feature is disabled OR the index is not ready raises `Fts5NotReadyError` and the MCP wrapper surfaces it as a JSON error envelope with a `suggestion` field pointing at `search_method='auto'`. `QueryCache._make_key` gains a 5th `search_method` param so paths cannot share cache entries. `MetricsCollector` gains five FTS5 counters plus a bucketed latency histogram (`knowledge_rag_fast_path_hits_total{path}`, `..._fallback_total{reason}`, `..._latency_seconds`, `..._errors_total{error_class}`, `..._rerank_skipped_total`) exposed through `/metrics`. New coverage: `tests/test_search_method_override.py` (5 IT), `tests/test_metrics.py` (2 UT), `tests/test_e2e_fts5.py` (7 E2E), and extensions to `tests/test_search.py` (16 IT/UT — dispatch, config toggle, cache key, metrics scrape), `tests/test_backwards_compat.py` (3 UT — MCP tool signature + guardrail), `tests/test_fts5_index.py` (3 UT — fallback dispatch, busy_timeout, NotReady message). Fase 3 of the FTS5 Lexical Fast-Path plan.
-- **NEW (search)**: Query router lexical/semantic classifier (`mcp_server/query_router.py`) ships isolated and unused. Static regex classifier per ADR-002 — patterns are pre-compiled at construction (fail-fast on `re.error`) and matched in YAML-declared order (first-match-wins, OQ-2). API surface: `QueryRouter(patterns: Sequence[str])` plus `classify(query: str) -> Literal["lexical", "semantic"]`; empty query classifies as `"semantic"` (safe default). Zero coupling to `mcp_server/fts5_index` — the router is storage-agnostic. Task 03 will wire the dispatch inside `KnowledgeOrchestrator.query()` behind `config.fts5_enabled`; this PR is deliberately unwired so runtime behaviour is preserved. New coverage in `tests/test_query_router.py` (19 tests covering UT-001..UT-013 including a `hypothesis` property test). Fase 2 of the FTS5 Lexical Fast-Path plan (`.compozy/tasks/fts5-lexical-fast-path/`).
-- **NEW (search)**: FTS5 lexical index module (`mcp_server/fts5_index.py`) ships isolated and unused behind the opt-in `search.lexical_fast_path.enabled` config field (default `false`). Encapsulates the dedicated `data/fts5_index.db` SQLite FTS5 store with the ADR-005 tokenizer (`unicode61 remove_diacritics 2 tokenchars '-_.'`) so composite identifiers like `MDR-AD002`, `CVE-2021-4034`, `T1078.001`, `pass-the-hash`, `context.py` survive tokenization intact. Public surface: `Fts5LexicalIndex` (search + connection lifecycle + WAL/busy_timeout=5000ms/synchronous=NORMAL PRAGMAs per ADR-001), `Fts5MigrationState` (atomic JSON marker via `tempfile` + `fsync` + `os.replace`), and three `RuntimeError`-derived exceptions (`Fts5NotReadyError`, `Fts5CorruptError`, `Fts5MigrationError`) per ADR-004/Q4. `Config` gains four `fts5_*` fields (`fts5_enabled`, `fts5_min_hits`, `fts5_rerank_enabled`, `fts5_patterns`) backed by a new `_get_nested()` helper that mirrors the `models.reranker.*` pattern. `config.example.yaml` documents the new `search.lexical_fast_path.*` block (commented out). All FTS5 queries use prepared statements and every user-supplied token is quoted so FTS5 metacharacters (`MATCH`, `NEAR`, `OR`, `AND`, `NOT`, `*`, `:`, `(`, `)`, `"`) cannot leak through. Task 03 will wire the dispatch inside `KnowledgeOrchestrator.query()`; this PR is deliberately unwired so runtime behaviour of v4.8.1 is preserved byte-for-byte. New coverage in `tests/test_fts5_index.py` (25 tests covering UT-020..028, UT-054..058, UT-061, IT-MIG-001) and `tests/test_config_fts5.py` (9 tests covering UT-030..038). Fase 1 of the FTS5 Lexical Fast-Path plan (`.compozy/tasks/fts5-lexical-fast-path/`).
-### v4.8.0 (2026-08-06) — Multilingual Foundation + Zero-Downtime Reindex
-v4.8.0 é a release de fundação para migração pra embeddings multilingual (`intfloat/multilingual-e5-large`) sem forçar downtime nem breaking change. Sete fases entregaram: security wire (7 vetores fechados que existiam desde v4.5.1), embedding profiles com prefix opt-in, GPU auto-detect com dependency chain documentada, batch/parallel indexing configurável + fix da assimetria BM25/semantic candidate pool, progress granular + resume checkpoint, dual-collection swap zero-downtime, e refactor pra manter complexidade Radon C+ na superfície tocada.
-Zero breaking change: usuários que atualizarem SEM tocar em `config.yaml` continuam com `bge-small-en-v1.5` byte-for-byte. Opt-in para multilingual: `profile: "multilingual"` + `reindex_documents(force=True)` — durante o reindex, RAG continua servindo da collection antiga (zero downtime via staging swap). Detalhes de upgrade em `docs/migration-v4.8.0.md`.
-- **REFACTOR (server + config)**: extracted 40+ helpers from 12 functions touched by v4.8.0 F1–F5 to enforce Core hard limits (function ≤30 lines). Biggest wins — `KnowledgeOrchestrator._index_all_impl` split from 246 → 23 lines (14 focused helpers covering setup / per-doc processing / progress metrics / persistence / teardown), `Config.__post_init__` split from 185 → 12 lines (13 domain validators), `reindex_documents` MCP tool from 100 → 30 lines (mode resolution + resume hydration + response formatting extracted to module helpers). Also refactored `_index_document` (91→19), `_rebuild_via_swap` (66→29), `_validate_staging` (56→24), `_cleanup_stale_staging_collections` (48→26), `get_reindex_status` (49→12), `_print_gpu_banner` (46→20), `start_reindex_background` (46→26), `_swap_collections_atomic` (43→25), `_route_load` (41→9). New sentinel `_SKIP_DOC` distinguishes "caller must skip" from "index as fresh" in the per-doc worker. Radon complexity average dropped from D (23.4) to C (17.2); zero D+ functions remain in F1–F5 touched surface. File-level extract (`server.py` = 4009 lines, `config.py` = 990 lines) deferred to v4.9.0 because `test_backwards_compat.py` validates the MCP contract by AST and moving classes across modules multiplies regression surface. Zero behavior change — full test sweep (`test_config` + `test_embedding_profile` + `test_gpu_auto` + `test_batch_parallel` + `test_reindex_resume` + `test_swap_zero_downtime` + `test_backwards_compat` + `test_bm25_*` + `test_search` + `test_dedup` + `test_ingestion*` + `test_lazy_embeddings` + `test_reranker_fallback` + `tests/security/` + all misc) = 557 passed / 3 skipped / 9 xfailed / 0 failed. Full audit report in `docs/refactor-audit-v4.8.0-fase-6.md`. v4.8.0 Fase 6.
-- **PERF (reindex)**: `nuclear_rebuild(swap=True)` is now the default, replacing the destructive-first rebuild that took the RAG offline for the entire duration (4min–40h depending on corpus + hardware). New workflow — cleanup stale stagings (24h TTL) → snapshot orchestrator state (`self.collection` / `self.bm25_index` / `self._indexed_docs` / `self._source_to_docid`) → create `{collection_name}__staging_{unix_ts}` (timestamped to avoid collisions with concurrent or previously-crashed rebuilds) → populate via temporary orchestrator rebind (`self.collection` points at staging, `self.bm25_index` is a throwaway `BM25Index()` so production BM25 keeps serving queries throughout) → validate three gates (`count >= baseline * 0.9` with 10% loss threshold for parser-skipped docs / 4 of 5 canonical queries `readme/function/import/return/class` return hits / `query()` does not raise, catching embedding dim mismatches) → atomic two-step swap via `Collection.modify(name=)` (prod → `__old_{ts}` frees the name, staging → prod assumes it, delete `__old_{ts}` non-fatally) with rollback-rename on mid-swap failure → post-swap BM25 rebuild from swapped-in ChromaDB contents + query cache invalidation. Any failure in populate/validate/swap triggers rollback via the snapshot and staging cleanup — production sees zero net change. Startup cleanup handles crash-orphaned stagings automatically (also runs before each rebuild). Storage doubles temporarily during rebuild (both collections on disk), back to 1x after swap. `nuclear_rebuild(swap=False)` preserves the legacy destructive behavior byte-for-byte in `_rebuild_destructive` for backwards compat / forced-cleanup edge cases. New `tests/test_swap_zero_downtime.py` (15 tests, ~1.7s, all mocked — no real ChromaDB or FastEmbed touched) covers naming format + populate BM25 isolation + all three validation gates + fresh-install zero-baseline path + post-swap `self.collection` reconnect + BM25 rebuild only after swap success + 100 parallel queries against a captured production handle during populate (zero errors, non-empty results) + stale/recent staging cleanup + non-staging collection preservation + backwards-compat dispatch. Docs in `docs/reindex-operations.md` section "Zero-downtime Rebuild (v4.8.0 Fase 5+)". v4.8.0 Fase 5.
-- **NEW (reindex)**: `reindex_documents(resume=True)` recovers from `data/reindex_checkpoint.json` after an interrupted smart reindex. Checkpoint is written every 500 docs or 30s (whichever first), and stores `indexed_doc_ids` + `chunks_processed` + `config_signature` (SHA256 of `embedding_model | embedding_dim | chunk_size | chunk_overlap`). A config mismatch between checkpoint write and resume load invalidates the checkpoint with a WARN — this prevents a mixed collection (partial old-model vectors + partial new-model vectors) which would silently degrade retrieval. The combination `resume=True + full_rebuild=True` is rejected with a structured error because nuclear rebuild wipes the collection first — resuming into a partial state would leave no coherent index. The `resume=True` flag also implicitly forces `mode='smart_reindex'` even when `force=False` was passed, so an interrupted smart run cannot silently fall back to `incremental` (which would ignore the checkpoint entirely). Existing 2-arg `reindex_documents(force, full_rebuild)` signature preserved — `resume` is an opt-in tail kwarg. Missing / corrupt / future-version / non-dict checkpoints all degrade gracefully to "start fresh" instead of raising. Written to `data/reindex_checkpoint.json` via atomic `.tmp` + `os.replace()` — Windows-safe on NTFS in-directory. Cleared automatically on successful reindex completion. Metadata (`index_metadata.json`) is flushed alongside every checkpoint write so `_indexed_docs` on disk stays in sync with the checkpoint's `indexed_doc_ids` list. New `tests/test_reindex_resume.py` (22 tests, all `object.__new__` isolation — no ChromaDB, no FastEmbed download) covers write cadence + atomic write + schema + load validation (6 failure modes) + resume kwarg happy path + rejection combos + status field flow. v4.8.0 Fase 4.
-- **NEW (reindex)**: `get_reindex_status()` now returns 6 new fields during active reindex — `chunks_processed` (chunks committed to ChromaDB so far), `chunks_total` (rolling estimate, 0 during warmup then running average from completed docs × `total_files`), `throughput_cps` (chunks/sec, sliding window bounded by the smaller of 100 samples or 30 seconds — deque `maxlen=100` combined with age-based pruning each iteration keeps the number stable during transient stalls without diluting current speed with ancient samples), `eta_seconds` (estimated seconds to completion, derived from throughput + remaining chunks, guarded against div-by-zero), `checkpoint_saved_at` (ISO timestamp of last checkpoint write, `null` until first checkpoint at 500 docs / 30s), `resumed` (bool — `true` when the current run was recovered from a checkpoint via `resume=True`, `false` otherwise). Enables real-time progress dashboards and the "should I keep waiting or restart" call. Idle path (`active: false`) unchanged — still returns just `last_result` or `last_error`. v4.8.0 Fase 4.
-- **DOCS (reindex)**: `docs/reindex-operations.md` NEW — documents the sync-vs-async gotcha for `reindex_documents(full_rebuild=True)` (daemon thread dies with process → RAG offline until manual restart), recommends `orchestrator.nuclear_rebuild()` sync for CLI scripts and `reindex_documents(force=True) + resume=True` for long unstable smart rebuilds. Also covers resume semantics (only valid with `full_rebuild=False`, implicitly forces `smart_reindex` mode, graceful degrade to fresh start on missing/corrupt/version/signature mismatch), checkpoint cadence (500 docs OR 30s, whichever first, plus rationale for the OR condition), `config_signature` invalidation semantic, full lifecycle (write on cadence, clear on success, clear on failed resume load), progress fields table with warmup behavior, example recovery flow showing crash → `ls checkpoint` → `resume=True` → poll status with `resumed:true` marker, and escalation rules of thumb for the three most likely operator questions. v4.8.0 Fase 4.
-- **PERF (indexing)**: `documents.batch_size` (default 500) and `documents.parallel_workers` (default 1, opt-in) are now configurable in `config.yaml`. The previously hardcoded `_CHROMA_BATCH_SIZE = 500` in `server.py:_index_document` continues as fallback constant for tests that instantiate the orchestrator without a full `Config` (via `object.__new__`, as `tests/test_search.py` does). When `parallel_workers > 1` AND the document produces more than one batch, the per-batch `collection.add(...)` calls run inside a `ThreadPoolExecutor(max_workers=parallel_workers)`. Single-batch documents skip the pool entirely — no orchestration overhead to extract from a single call. Gain comes from SQLite writes overlapping with the NEXT batch's ONNX inference (embedding itself is serialized by ONNX session lock — never parallel inference). Windows users should monitor stability at `workers > 4` (extra `[WARN]` on startup). `batch_size` clamped to `[1, 5000]`, `parallel_workers` clamped to `[1, 16]` — out-of-range values are clamped with a `[WARN]`. New `bench/test_bench_reindex.py` (3 benchmarks) uses a `_SleepingCollection` stub with 5ms per-`add()` sleep so the parallel path measurably overlaps without depending on a real ChromaDB; local numbers: reindex_batch_2000 5.66ms, reindex_default 5.68ms, reindex_parallel_4 7.30ms (200-chunk doc, 4 concurrent batches, sequential would be ~20ms). New `tests/test_batch_parallel.py` (20 tests, ~1.6s) covers config parsing, clamping, Windows-only warn on `workers > 4`, sequential vs parallel dispatch, single-batch skip, `getattr` fallback to `_CHROMA_BATCH_SIZE`, exception propagation via `.result()`, and empty-doc short-circuit. Defaults preserve v4.7.1 behavior byte-for-byte. v4.8.0 Fase 3.
-- **FIX (search)**: `search.max_results` default raised from `20` to `100`. This eliminates the asymmetric candidate pool in hybrid retrieval where `_do_semantic` clamped candidates to `min(max_results * 3, config.max_results) = min(15, 20) = 20` while BM25 pulled up to `max_results * 20 = 400` — semantic silently starved without any log signal, degrading hybrid retrieval quality on any query where the semantic branch could have contributed better candidates. Callers passing `max_results` explicitly in the MCP tool call (`search_knowledge`, `search_similar`) are unaffected — only the config-loaded default changed. New `TestDoSemanticCandidateMath` class in `tests/test_search.py` (2 tests) pins the fix against future regressions: `test_semantic_asks_chromadb_for_3x_max_results` proves the 3× semantic candidate pool, `test_semantic_pool_is_bounded_by_config_max_results` proves the cap still works when `max_results * 3` exceeds it. v4.8.0 Fase 3.
-- **CHANGE (gpu)**: `models.embedding.gpu` is now tri-state (`"auto"` | `"true"` | `"false"`) with `"auto"` as the new default. In auto mode, `FastEmbedEmbeddings.verify_gpu_readiness()` runs four startup checks (`CUDAExecutionProvider` present in `onnxruntime.get_available_providers()` / required NVIDIA DLLs reachable via `PATH` — `cudart64_12.dll`, `cudnn64_9.dll`, `cublasLt64_12.dll` on Windows and their `.so.12` / `.so.9` counterparts on Linux / `nvidia-smi --query-gpu=name,memory.total` exits 0 / a minimal single-op ONNX `InferenceSession` initializes on the CUDA provider) and uses CUDA when all pass, CPU otherwise. Legacy bool `gpu: true`/`gpu: false` continues to work — normalized to the string form internally. The startup banner now prints on every path (including CPU-only and fallback), reports the mode (`auto-cuda` / `auto-cpu-fallback` / `forced-cpu` / `forced-cuda` / `forced-cuda-fallback`), and surfaces the probe `fallback_reason` on CPU paths with a hint pointing at the full pip install chain. Full dependency chain (onnxruntime-gpu CUDA 12 variant via `--extra-index-url` + `nvidia-cudnn-cu12` + `nvidia-cublas-cu12` + siblings) and troubleshooting for the six most common failures documented in `docs/gpu-setup.md`. Zero behavior change for users who had `gpu: false` explicitly. New coverage in `tests/test_gpu_auto.py` (13 tests, all mocked — no real GPU required to run). v4.8.0 Fase 2. (#149)
-- **NEW (embedding)**: `models.embedding.profile` opt-in preset (`compact` | `quality` | `multilingual` | `custom`) plus `query_prefix` / `passage_prefix` fields. The `multilingual` profile ships `intfloat/multilingual-e5-large` (1024D, 100+ languages) with the required `"query: "` / `"passage: "` prefixes wired into `FastEmbedEmbeddings.__call__`, `.embed_query`, and `.embed_documents`. `compact` preserves the current `bge-small-en-v1.5` default byte-for-byte. Changing profile or prefix requires `reindex_documents(force=True)` because existing chunks were embedded without the new prefix. (#148)
-- **FIX (bm25)**: BM25 tokenizer is now Unicode-aware. Before this fix, the `[a-z0-9]` character class in `BM25Index._tokenize()` and `_metadata_path_score()` (server.py:652, 659, 720) dropped every code point outside Basic Latin — Cyrillic, Greek, CJK, Arabic corpora silently degraded to semantic-only search (empty `bm25_rank`, `search_method: semantic`, no warning). Portuguese/Spanish/French text with diacritics was **fragmented** on the accent: `"informação técnica"` tokenised as `['informa', 'o', 't', 'cnica']` and BM25 scored garbage fragments instead of the actual words. The regex now uses `[^\W_]+(?:-[^\W_]+)*` which keeps hyphenated composites (`CVE-2024-1234`, `rule-a002`, `pass-the-hash`) byte-identical to prior behaviour while also matching letters from any script. All 28 tests in `test_bm25_tokenizer_fragment.py` remain green. New coverage in `tests/test_bm25_unicode_tokenizer.py` (13 tests) exercises Cyrillic / Greek / Arabic / CJK / PT-BR / mixed-script / composite-with-diacritics / underscore-separation. Closes #145. (#147)
-- **DOCS (security)**: rewrite `SECURITY.md` reporting section — remove the `lyonzin@users.noreply.github.com` fallback (GitHub `noreply.github.com` addresses are outbound-only and never receive mail, so that channel was decorative) and direct all reports to the GitHub Security Advisory form at `/security/advisories/new`. Private vulnerability reporting is now enabled on the repo, so the form is available to any GitHub user without collaborator status. Closes #146. (#147)
-- **FIX (security)**: wire `validate_path_within` on all filepath-taking orchestrator tools — `get_document`, `add_document_from_content`, `update_document_content`, `remove_document_by_path`, `search_similar`. Escape attempts return a structured `{"error": "Filepath rejected: ..."}` and touch nothing on disk. Closes 5 latent path traversal / arbitrary-file-{read,write,delete} vectors that the `mcp_server/security.py` primitives had covered since v4.5.1 but which never had callers in the mutation path. (#147)
-- **FIX (security)**: wire `sanitize_external_content` on `add_from_url`. The fetched body now flows through a new `external_source` kwarg on `add_document_from_content` (default `None` — operator ingests stay byte-identical) which fences it in a provenance envelope and defuses known prompt-injection sentinels (`<|im_start|>`, `[INST]`, etc.) before the parser or any downstream LLM sees it. Closes OWASP LLM01:2025 on the URL ingest path. (#147)
-- **FIX (security)**: install `BearerAuthMiddleware` on HTTP transports (`sse`, `streamable-http`) when `config.auth_bearer_token` is set. Wraps the FastMCP ASGI app and serves via uvicorn; unset token keeps prior `mcp.run()` open-port behaviour with a `[WARN]` on stderr; `stdio` transport is never wrapped. Closes the auth-bypass gap where `auth_bearer_token` had existed as a config field since v4.0.0 but was never compared. (#147)
-- **NEW (tests)**: `tests/security/test_add_from_url_sanitized.py` and `tests/security/test_bearer_middleware_attached.py` — integration tests that prove the wire (not just the library primitives). The `@pytest.mark.xfail("integration pending v4.6.0")` markers on 9 tests across `test_path_traversal.py`, `test_bearer_auth.py`, `test_prompt_injection.py` are removed — they now pass. `tests/security/` totals: 138 passed, 7 skipped, 6 xfailed. (#147)
-- **DOCS (perf)**: `docs/perf-baseline-v4.7.1.md` + `perf-baseline-v4.7.1.json` — reference microbenchmarks + `nuclear_rebuild()` timing (100-doc synthetic corpus) captured at the tip of v4.7.1. Non-runtime baseline for the planned Phase 3 batch-parallel embedding work in v4.8.0.
-- **NEW (release automation)**: `release.yml` now has a `yank-superseded` job that reads a `YANKS:` marker from the release body and automatically yanks the listed version from PyPI + deprecates it on NPM after the new version publishes. Format: `YANKS: v4.7.0` or `YANKS: v4.7.0 — some reason`. Requires the `PYPI_API_TOKEN` repo secret (classic scoped token — Trusted Publisher OIDC does not currently support yank). Job runs after `publish-pypi`/`publish-npm`/`publish-docker`, is idempotent, and degrades gracefully when secrets are missing (emits `::warning::` instead of failing). If the marker is absent, the job is a no-op.
-### v4.7.1 (2026-08-01) — Documentation Hygiene
-- **CHORE (docs, tests)**: sanitize identifiers in test fixtures and CHANGELOG examples. v4.7.0 referenced code names from a real deployment corpus in `tests/test_bm25_tokenizer_fragment.py` and the v4.7.0 CHANGELOG entry; those are replaced with synthetic placeholders (`RULE-A00X`, `PROJECT-Custom001-xxxx`) and well-known public identifiers (`CVE-*`, `MS17-*`, `ADR-*`, `T1078.002`) that carry no organization-specific taxonomy. Zero behavior change — all 28 fragment tests pass unchanged, tokenizer logic identical.
-- **NOTE**: v4.7.0 is **yanked from PyPI** and **deprecated on NPM** because its published README contained the same corporate example strings. The Docker tag `v4.7.0` remains (image tags are immutable) but `latest` now points to v4.7.1. Please upgrade — v4.7.0 and v4.7.1 are functionally equivalent.
-- **VERSION**: 4.7.0 → **4.7.1** (PATCH — documentation hygiene, zero code / API / config change).
-### v4.7.0 (2026-07-31) — BM25 Fragment Query Support ⚠️ **YANKED — use v4.7.1**
-- **FIX (retrieval)**: BM25 tokenizer now emits **sub-tokens** for hyphenated alphanumeric-code composites, so fragment queries no longer silently return `NO_RESULTS`. Before v4.7.0, `RULE-A002` was indexed as a single token `rule-a002`; queries like `A002`, `RULE`, `B005` returned zero even when the composite lived in the corpus. This is not a bug specific to any naming scheme — it hit every hyphenated code taxonomy in typical infosec / doc corpora (`RULE-*`, `CVE-*`, `ADR-*`, `MS17-*`, `PROJECT-Custom001-xxxx`). The tokenizer now emits both the composite token AND its sub-parts of length ≥ 2 (`rule-a002` → `["rule-a002", "rule", "a002"]`). IDF preserves ranking — composite matches still rank above fragment matches because the composite is rarer. **Heuristic (perf-safety)**: sub-token expansion is triggered ONLY when the composite contains at least one digit — so `pass-the-hash`, `state-of-the-art`, and other natural-language hyphenated phrases stay as single tokens (expanding them would flood the inverted index with stop-word-like sub-parts and hurt concurrent-query throughput). (#140)
-- **NEW (tests)**: `tests/test_bm25_tokenizer_fragment.py` — 28 tests across 4 classes covering unit tokenizer behavior, end-to-end fragment matching, multi-doc disambiguation, and the 5 query patterns explicitly reported (`RULE-A019`, `PROJECT-Custom001-xxxx`, `RULE`, `A019`, `B005`). Includes retrocompat sentinel + IDF ranking invariant. Baseline: 314 → 342.
-- **UPGRADE NOTE**: run `reindex_documents(force=True)` once after upgrade to rebuild the BM25 inverted index with the new sub-token emission. ChromaDB vectors are untouched. Expect a **~30–50% increase in BM25 index memory** (measured +32.5% on synthetic corpus) — negligible for typical corpora, worth reviewing for deployments with >100K docs.
-- **KNOWN LIMITATION**: alphanumeric-glued tokens without separators (single-token identifiers with no hyphens, hash prefixes) still require exact match — no sub-token expansion possible without character n-grams (5-10× index overhead). Tracked as follow-up.
-- **VERSION**: 4.6.0 → **4.7.0** (MINOR — tokenization behavior change + reindex requirement, though no API/config break).
-### v4.6.0 (2026-07-30) — MCP spec 2026-07-28 via Anthropic Tier 1 SDK (mcp 2.x)
-- **NEW (protocol)**: adopt the [MCP spec `2026-07-28`](https://blog.modelcontextprotocol.io/posts/2026-07-28/) — stateless request/response core, per-request `_meta.io.modelcontextprotocol/protocolVersion` + `clientCapabilities`, `serverInfo` on responses, retirement of the `initialize`/`initialized` handshake and the `Mcp-Session-Id` header. The MCP client Claude Code (and every Tier 1 client) negotiates the spec version per request, so this release stays backwards-compatible for clients speaking earlier spec revisions.
-- **NEW (deps)**: bump `mcp` from `>=1.6.0,<2.0.0` to `>=2.0.0,<3.0.0`. Anthropic published `mcp 2.0.0` on 2026-07-28 as the Tier 1 Python SDK — it speaks the new spec natively and is the direct upstream reference. Delivers the follow-up promised in v4.5.0-post — no longer trapped on `mcp.server.fastmcp` which upstream `mcp 2.0.0` renamed to `mcp.server.MCPServer`.
-- **CHANGE (imports)**: `mcp_server/server.py` now imports `MCPServer` from `mcp.server` instead of `FastMCP` from `mcp.server.fastmcp`. `@mcp.tool()` / `@mcp.resource()` / `@mcp.prompt()` decorator ergonomics are unchanged — only the class name and import path move. All 13 MCP tool signatures, all tool names, and every public function under `mcp_server.*` are **frozen and unchanged** — `check_api_surface.py --check` passes clean, `test_backwards_compat.py` stays green.
-- **CHANGE (constructor)**: `MCPServer(...)` (like FastMCP 3.x) no longer accepts `host` / `port` on the constructor; those parameters now belong to the transport and are passed to `mcp.run(transport=..., host=..., port=...)` on the non-stdio branches. stdio users see zero behaviour change.
-- **CHANGE (server identity)**: `MCPServer(name="knowledge-rag", version="4.6.0")` — server now advertises its version explicitly in `serverInfo`, matching the `2026-07-28` spec.
-- **NON-GOAL — why not `fastmcp` (jlowin)**: an initial attempt via the third-party standalone `fastmcp` package added ~20 transitive dependencies (from its `[client,server]` extras) and pushed `test_bench_orchestrator_idle_rss` +21.9% and `test_bench_query_cache_5000_entries` +17.1% — a real regression, not jitter. Cutting the extras to `fastmcp-slim[mcp]` broke `@mcp.tool()` at runtime (`ImportError: FastMCP server support is not installed`). Anthropic's official `mcp 2.x` is the correct entry point.
-- **VERSION**: 4.5.1 → **4.6.0** (MINOR — new spec adoption via Tier 1 SDK; every public API + every MCP tool signature preserved).
-### v4.5.1 (2026-07-28) — Fase 1 Security Hardening (library, standalone)
-- **NEW (security)**: Fase 1 Security Hardening — a standalone `mcp_server.security` library ships with the tools needed to close three attack classes against untrusted document ingestion. **Nothing in the existing call graph changes** in v4.5.1: `security.py` is imported by no other module in this release, so byte-identical behaviour is preserved for every user. Integration with `add_document` / `add_from_url` / `parse_file` / MCP HTTP transports lands in v4.6.0 (14 tests in `tests/security/` are marked `xfail` accordingly — they turn green once the callers are wired up). Users motivated to adopt hardening today can `from mcp_server.security import ...` explicitly. Contract per-defense:
-  - **CWE-22 / CWE-59** path traversal + symlink escape: `validate_path_within(base, candidate)` + `is_path_within(base, candidate)` + `PathEscapeError`. Rejects `..`, absolute-outside-base, and symlinks whose target leaves the corpus root.
-  - **OWASP LLM01:2025** prompt injection: `neutralize_injection_sentinels` + `sanitize_external_content` + `wrap_external_content` + `detect_external_marker`. Wraps content fetched from URLs / dropped files with tagged sentinels the downstream LLM can distinguish from operator-authored context.
-  - **CWE-287** unauthenticated HTTP transport: `BearerAuthMiddleware` + `bearer_token_matches` (constant-time comparison) + `extract_bearer_token`. Attach to a Starlette / FastAPI app; stdio transport bypasses auth by construction (no network surface).
-- **NEW**: `docs/adr/0001-fase1-security-hardening.md` — ADR capturing threat model + v4.6.0 integration roadmap.
-- **NEW**: `.github/SECURITY.md` — GitHub vulnerability reporting policy pointer + `.github/openssf-best-practices.md` (evidence pack for OpenSSF Best Practices badge registration).
-- **NEW**: `tests/security/` (71 tests total; 57 library unit tests green in v4.5.1, 14 integration tests `xfail` pending v4.6.0 wire-up, `strict=False` so they auto-turn-green after integration) + `tests/test_security_docs.py` (9 assertions pinning `SECURITY.md`, README badge block, dependabot weekly pip schedule).
-- **DOCS**: README carries the OpenSSF Best Practices badge (placeholder project ID until registration completes).
-- **DEPS**: `dependabot.yml` pip schedule tightened `monthly` → `weekly` (OpenSSF-recommended floor for language ecosystems).
-- **VERSION**: 4.5.0 → **4.5.1** (PATCH — additive library only, zero behaviour change on the default install).
-### v4.5.0-post (rolling fixes since v4.5.0 release)
-- **FIX (deps)**: pin `mcp<2.0.0` in both `requirements.txt` and `pyproject.toml` after the upstream `mcp` package published 2.0.0, which drops/relocates `mcp.server.fastmcp`. Every `mcp_server.server` import chain — and therefore every test module — was failing collection with `ModuleNotFoundError: No module named 'mcp.server.fastmcp'` on fresh CI runners across all 9 OS×Python cells. Pin restores green until we migrate to the new 2.x FastMCP entry point in a follow-up. Root cause: `requirements.txt` had `mcp>=1.0.0` unbounded, so `pip install -r requirements.txt` in CI ignored the pyproject constraint. (#122)
-- **FIX**: `_ensure_bm25_index` no longer traps the guard flag `_bm25_initialized` in a stuck-True state when the server boots against an empty ChromaDB collection. Prior behavior set the flag unconditionally at the end of the guarded block, so a fresh-install bootup or a metadata-mapping loss left BM25 permanently uninitialized: subsequent `add_document()` calls populate `bm25_index.corpus` but do not rebuild the inverted index, and `_ensure_bm25_index` — the only path that does — short-circuited on the stale flag. All keyword-only searches returned zero results; hybrid searches returned only semantic hits with `bm25_rank: null`. The flag is now set only after a build that actually produced an index; empty collections and exceptions leave it False so the next call retries. (#114)
-- **TEST**: New `TestEmptyBootupDoesNotTrapGuardFlag` (5 tests) pins the contract — empty-collection boot leaves flag False, populated collection marks True, empty-then-populated recovery works, empty `get()` result leaves False, and `build_index()` exceptions leave False for retry. Baseline: 271 → 276.
-### v4.5.0 (2026-07-06) — Hybrid Search Ranking & Routing Fix
-- **FIX**: `search_knowledge` now searches the entire index when the user omits `category_filter`. The internal `_route_by_keywords()` heuristic previously acted as a hard where-filter on both the semantic and BM25 branches, so queries whose terms happened to map to a sparsely-populated category could return two documents while thousands of relevant chunks in other categories were silently dropped. The router is now **informational only**: the `routed_by` field is still populated in every result for telemetry (public API unchanged), but the candidate set is never restricted. Users who want a hard filter still get it by passing `category_filter=...` explicitly — which continues to filter BM25 consistently with #109. (#112)
-- **NEW**: Hybrid search adds a small bounded ranking boost when query terms match indexed `source` or `filename` metadata, helping navigational queries surface the canonical file for a topic instead of adjacent files that only cross-reference it. The boost is capped at ~20% of typical RRF magnitudes, so it breaks near-ties without overriding semantic or BM25 signal. Public API unchanged. (#110, thanks @Hohlas)
-- **TEST**: New `TestKeywordRoutingBehavior` (3 tests) pins the routing fix — BM25 and semantic branches must both see the full corpus when no explicit filter is passed, and explicit `category_filter` still overrides the router. New `TestPathAwareRanking` covers the path-metadata boost. Baseline: 266 → 271.
-- **UPGRADE NOTE**: warm `query_cache` entries from before v4.5.0 should be invalidated by restarting the server so cached responses no longer reflect the pre-fix restrictive behavior.
-### v4.4.0 (2026-07-06) — Cross-Platform Installer & Hybrid Search Category Filter
-- **NEW**: Cross-platform, multi-LLM-client installer (`install.py`) driving both `install.sh` (Linux/macOS) and `install.ps1` (Windows) as thin wrappers. One codebase, one behavior across every OS.
-- **NEW**: Auto-detects and registers `knowledge-rag` in 8 LLM clients — Claude Code, Claude Desktop, Cursor, Windsurf, VS Code (Copilot Chat), Cline, Gemini CLI, Zed — writing to each tool's canonical config path with the correct JSON schema per client (VS Code uses `servers`, Zed uses `context_servers`, everyone else uses `mcpServers`).
-- **NEW**: `--for <clients>` / `--exclude <clients>` opt-in/opt-out selection, `--dry-run` preview, `--list-clients` registry inspection, `--pypi-version <ver>` pinning, `--skip-init` / `--skip-model` for fast reruns. See `python install.py --help`.
-- **FIX**: `install.ps1` no longer writes MCP config to `~/.claude/mcp.json` (a stale secondary path); it now targets `~/.claude.json` — the file Claude Code actually reads — via idempotent JSON merge that preserves every existing MCP server entry with an automatic `.knowledge-rag.bak` backup.
-- **FIX**: `install.ps1` gains PyPI mode (`pip install knowledge-rag`) and runs `mcp_server.server init` on install — feature parity with `install.sh`.
-- **FIX**: MCP server spec no longer uses the fragile `cmd /c cd /d ... && python ...` wrapper on Windows; it emits the standard `command` + `cwd` shape supported natively by every modern client.
-- **FIX**: `install.sh` guards against `sh install.sh` (bash-only features now emit a clear error instead of a cryptic syntax failure).
-- **FIX**: Both scripts now correctly advertise **13 MCP tools** (was outdated at 12; `get_reindex_status` shipped in v4.3.0).
-- **FIX**: Windows-side `install.ps1` prefers `winget install Python.Python.3.12 --scope user` (no admin), falls back to python.org 3.12.7 (was pinned to 3.12.0).
-- **FIX**: Hybrid search now applies the active category filter to BM25 results before RRF fusion, preventing keyword-only BM25 hits from other categories from leaking into filtered searches. Both leak paths are closed: BM25 candidates are metadata-filtered before RRF (with `top_k` widened to `max_results * 20` to compensate for post-filter drop), and the fallback fetch during fusion re-checks `category` before adding a chunk to `combined_scores`. Note: the `category_filter` guard now also applies to the keyword-routed category — `_route_by_keywords()`-inferred routing filters BM25 too, consistent with the semantic branch. Users with warm `query_cache` entries should restart the server to invalidate stale results. (#109, thanks @Hohlas)
-- **TEST**: New `tests/test_installer_no_data_loss.py` (22 tests) locks in the installer's zero-data-loss contract across all three JSON schemas (`mcpServers` / `servers` / `context_servers`): top-level keys preserved, sibling MCP servers byte-identical, `.knowledge-rag.bak` backup written before every mutation, idempotent second run, `--dry-run` writes nothing, atomic `os.replace` write. Baseline: 231 → 266.
-- **TEST**: New `TestHybridCategoryFilter::test_bm25_results_respect_category_filter` in `tests/test_search.py` — deterministic regression covering BM25-only hits with mixed categories. Baseline: 266 → 267.
-### v4.3.1 (2026-06-22) — Hybrid Search Fixes
-- **FIX**: Accept `"general"` as a valid category in `search_knowledge`. The parser hardcodes `"general"` as the fallback in `_detect_category` (`ingestion.py`), but the validator only built `valid_categories` from `config.keyword_routes` + `config.category_mappings.values()` — so users who customized `config.yaml` and dropped the default `"general": "general"` mapping hit `Invalid category` even though the index contained `general` documents. Validator now always tolerates `"general"`. (#98, thanks @Hohlas)
-- **FIX**: Skip BM25-only search results when Chroma can no longer resolve the chunk ID. Stale BM25 indices (typically right after `remove_document` or in the window between async reindex and BM25 rebuild) returned hits whose `collection.get()` came back empty; the previous fallback inserted entries with `document=""` / `metadata={}` into the reranker, polluting results with empty matches. The pipeline now `continue`s past those, dropping the stale hit cleanly. (#98, thanks @Hohlas)
-- **TEST**: Added `tests/test_pr98_regression.py` (4 tests) pinning both contracts so future refactors cannot silently revert either fix. Test count baseline: 227 → 231. (#99)
-- **CI**: Bumped `[tool.mypy] python_version` from 3.11 to 3.12 to accept PEP 695 `type` statements in the numpy stub (`numpy/__init__.pyi`) which were breaking the Pillar 7 strict gate. Only affects static analysis; `requires-python = ">=3.11"` unchanged. (#100)
-### v4.3.0 (2026-06-17) — Async Reindex, GPU CUDA 12, 13th MCP Tool
-- **NEW**: `get_reindex_status` MCP tool — lightweight reindex progress polling without computing full index stats. Returns active/idle status, percent, processed/total, errors, and last result.
-- **NEW**: `reindex_documents` now runs in background via daemon thread — returns immediately with `{"status": "started"}`. Eliminates MCP timeout on large document sets (5K+ files). Concurrent calls return `already_running` with current progress.
-- **NEW**: GPU acceleration with full CUDA 12 support — `onnxruntime-gpu` + 7 NVIDIA pip packages (`cublas`, `cudnn`, `cuda-runtime`, `cufft`, `cusparse`, `cusolver`, `curand`, `nvjitlink`). Server auto-detects GPU on startup with 4-step verification (providers, DLLs, nvidia-smi, session creation). Falls back to CPU gracefully.
-- **NEW**: `_setup_cuda_dll_paths()` adds NVIDIA pip package DLL directories to `PATH` automatically on Windows — onnxruntime finds CUDA 12 DLLs without a full CUDA Toolkit install.
-- **DEPS**: `[gpu]` extra expanded from 3 to 8 packages (added `cufft`, `cusparse`, `cusolver`, `curand`, `nvjitlink`).
-- **FIX**: GPU status reporting now uses actual ONNX session creation test instead of just checking `get_available_providers()` — prevents false "GPU ACTIVE" when CUDA DLLs are missing.
-- **DOCS**: GPU Acceleration section rewritten with complete requirements table, setup steps, verification instructions, and fallback behavior.
-- **DOCS**: Tool reference updated — `reindex_documents` async behavior documented, `get_reindex_status` reference added.
-- **TEST**: Backwards-compat baseline updated for 13 MCP tools.
-### v4.2.0 (2026-06-17) — Search Performance & Output Quality
-- **PERF**: Custom inverted-index BM25 replaces `rank-bm25` full-corpus scan — 128× faster keyword search on 50K+ chunk corpora. Only documents containing query terms are scored via posting lists.
-- **PERF**: `numpy.argpartition` for O(n) top-k selection instead of O(n log n) sort.
-- **PERF**: Batched adjacent chunk fetch — single ChromaDB `collection.get()` call replaces N round-trips per result.
-- **PERF**: O(1) reverse lookup via `_source_to_docid` dict eliminates linear scans of `_indexed_docs` in `search_similar`, `update_document`, `remove_document`, and `_expand_with_adjacent_chunks`.
-- **NEW**: `snippet_mode` parameter on `search_knowledge` (default: `true`) — truncates content to ~500 chars at natural break points with `content_length` field. Reduces token consumption by ~72%.
-- **NEW**: `min_score` parameter on `search_knowledge` (default: `0.0`) — filters results below a normalized relevance threshold. Response includes `filtered_by_score` count.
-- **NEW**: `filtered_by_score` field in search response JSON for transparency.
-- **DEPS**: `numpy` added as direct dependency (was transitive via fastembed); `rank-bm25` import removed from server.py.
-- **TEST**: 6 new tests for `min_score` filtering and `snippet_mode` truncation.
-- **TEST**: Updated backwards-compat baseline to include new `search_knowledge` parameters.
-### v4.1.2 (2026-06-17)
-- **FIX**: `_save_metadata` dict snapshot prevents concurrent modification crash during file watcher events.
-- **STYLE**: ruff format applied to server.py.
-### v4.1.1 (2026-06-17)
-- **FIX**: All `_indexed_docs` iterations now use `list()` snapshot, preventing `dictionary changed size during iteration` crash when FileWatcher modifies the index concurrently with MCP tool calls (affects `search_knowledge`, `search_similar`, `update_document`, `remove_document`, `evaluate_retrieval`, `list_categories`, `list_documents`)
-### v4.1.0 (2026-06-17)
-- **Added:** `query_expansion_groups` config for symmetric synonym expansion (#92)
-- **Improved:** `expand_query()` now returns deterministic expansion order (set → ordered list with dedup)
-### v4.0.1 (2026-06-16)
-- **FIX**: Orphan cleanup now runs before indexing loop, preventing chunk loss when files are moved (#90).
-- **FIX**: Chunk deduplication is now per-document instead of global, preventing cross-document chunk deletion (#91).
-- **FIX**: Added `on_moved` handler to `DocumentWatcher` for proper file move detection.
-- **FIX**: Startup preflight probes ChromaDB in a child process and moves crashing persistent indexes to `data/backups/auto-repair-*` before MCP initialization.
-- **FIX**: Reranker load failures now fall back to RRF ordering instead of failing `search_knowledge` on offline machines.
-- **FIX**: Virtualenv project-root detection now handles Python symlinks that resolve to the system interpreter.
-- **NEW**: `knowledge-rag-guarded` console script kept as an explicit guarded startup alias.
-### v4.0.0 (2026-06-09) — Enterprise Concurrent Access
-- **NEW**: SSE and streamable-http transport modes — 1 server serves N clients (`server.transport: "sse"` in config.yaml or `--transport sse` CLI).
-- **NEW**: Thread-safe shared state for concurrent queries — QueryCache locking, BM25 build lock, orchestrator double-checked locking.
-- **NEW**: ChromaDB WAL mode enabled automatically in SSE/HTTP mode for concurrent read performance.
-- **NEW**: Optional rate limiting — sliding-window counter, configurable RPM and burst, disabled by default.
-- **NEW**: Optional Prometheus metrics endpoint — tool call counts, latency histograms, separate port, disabled by default.
-- **NEW**: All 13 MCP tools instrumented with `@rate_limited` and `@instrument` decorators (zero-cost when disabled).
-- **NEW**: `--transport` CLI override for Docker/systemd deployments.
-- **NEW**: `pip install knowledge-rag[server]` optional dependency for SSE/HTTP (uvicorn).
-- **CHANGED**: SSE/HTTP mode auto-enables single-instance lock (port collision prevention).
-- **CHANGED**: `mcp` dependency bumped to `>=1.6.0` (SSE/streamable-http support).
-- **MIGRATION**: Default transport remains `stdio` — existing users need zero changes. See config.example.yaml for SSE setup.
-### v3.9.1 (2026-06-08)
-- **FIX**: Expand `~` in `config.yaml` path values (`documents_dir`, `data_dir`, `models_cache_dir`) via `expanduser()` on all platforms (#86).
-- **FIX**: Warn when `documents_dir` resolves to a non-existent path instead of silently indexing zero files.
-- **FIX**: File watcher now uses accumulate-mode debounce — bulk file copies no longer starve the reindex trigger.
-- **FIX**: Concurrent `index_all()` calls are serialized via `_index_lock` to prevent ChromaDB SQLite corruption.
-- **FIX**: `collection.add()` is batched (500 chunks/call) to cap memory usage during large reindex operations.
-- **NEW**: `KNOWLEDGE_RAG_WATCHER_DISABLED=1` env var to disable the file watcher for troubleshooting.
-- **NEW**: Progress logging every 10% for reindex operations with >100 documents.
-### v3.9.0 (2026-05-10) — Quality Gate
-**Major governance + CI hardening release. No runtime behavior change in `mcp_server/`. Public API surface unchanged from v3.8.1.**
-- **NEW** Quality Gate workflow (`.github/workflows/quality-gate.yml`) enforcing the 7 pillars on every PR: Security, Stability, Memory Leak, Versatility, Scalability, Versioning, Quality. 35+ status checks total.
-- **NEW** Nightly resilience workflow (`.github/workflows/nightly.yml`): chaos suite (failure injection), 1h soak test (50K-iteration loop), determinism check (full suite × 3), mutation testing (mutmut). Auto-opens GitHub issue on any nightly failure.
-- **NEW** Performance benchmark suite under `bench/` (12 microbenchmarks, pytest-benchmark) with 10% regression gate on every PR.
-- **NEW** Public performance dashboard via GitHub Pages (`.github/workflows/bench-pages.yml`) — chart of latency/throughput per commit. Dormant until repo Pages is enabled.
-- **NEW** Property-based fuzzing of all parsers via Hypothesis (`tests/test_ingestion_property.py`) — 200 random examples per CI run.
-- **NEW** Memory baseline regression tests (`tests/test_memory_baseline.py`, cross-platform via psutil) — RSS bounded under 1000 queries; nightly soak amplifies to 50K iterations.
-- **NEW** Property/locale/format/preset matrices (`tests/test_presets.py`, `tests/test_locale.py`, `tests/test_format_smoke.py`).
-- **NEW** Backwards-compatibility regression tests (`tests/test_backwards_compat.py`) — legacy YAML configs from v3.6.0 / v3.7.0 still parse; all 13 MCP tool parameter names frozen.
-- **NEW** AST-based public API surface diff (`scripts/check_api_surface.py`) — any breaking change blocks merge, baseline at `.github/api-surface-baseline.json`.
-- **NEW** CHANGELOG enforcement (`scripts/check_changelog.py`) — user-facing PRs must add a bullet under `## Unreleased`; bypass via `skip-changelog` label.
-- **NEW** Test count anti-regression (`scripts/check_test_count.py`) — guards against silent test deletion.
-- **NEW** Conventional commits required on every PR title (commitlint via `amannn/action-semantic-pull-request`).
-- **NEW** mypy `--strict` rolling out per-module (currently `instance_lock.py` + `preflight.py` + `scripts/`); interrogate docstring coverage ≥ 80%; radon, vulture, PR-size guard report-only.
-- **NEW** CI matrix expanded to 9 cells: Linux + Windows + **macOS** × 3.11 + 3.12 + **3.13** (all required at v3.9.0; macOS / 3.13 promoted from experimental after two clean cycles).
-- **NEW** Governance docs: `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, `.github/PULL_REQUEST_TEMPLATE.md`, 3 issue templates, expanded `CODEOWNERS`.
-- **NEW** Pre-commit hooks: ruff, gitleaks, version-sync, conventional commits.
-- **CHORE** `.github/codecov.yml` enforcing coverage trend gate (-0.5pp blocks; new code ≥ 70%).
-### v3.8.1 (2026-05-10) — hotfix
-- **FIX (critical)**: `FastEmbedEmbeddings.__call__` no longer returns vectors of zeros when the ONNX model fails to load or `embed()` raises. The previous behavior silently corrupted the index — ChromaDB stored zero embeddings, `count()` reported normal numbers, smart-reindex skipped the bad chunks, and queries returned garbage scores with no error visible. Now raises `EmbeddingModelLoadError` / `EmbeddingError`. (#36)
-- **FIX**: Sticky `_load_failed` flag — after a load failure, subsequent calls re-raise immediately instead of looping through HuggingFace download attempts (was the "frozen query" UX in v3.8.0).
-- **NEW**: Sanity checks in `__call__` — embed count and dim mismatches raise `EmbeddingError` instead of silently returning malformed vectors.
-- **TEST**: 7 new regression cases in `tests/test_lazy_embeddings.py`, including `test_does_not_return_zero_vectors_silently` as a guard for the whole class of bug.
-- **NOTE**: This is a pre-existing bug in master, not introduced by v3.8.0. v3.8.0 lazy-load expanded the impact (failures moved to query time). All v3.8.0 users should upgrade.
-### v3.8.0 (2026-05-10)
-- **NEW**: Lazy-load FastEmbed embedding model (~200MB ONNX runtime). Loads on first query instead of startup — idle `knowledge-rag` processes are now cheap, which matters when MCP stdio clients spawn parallel server processes (multiple Claude Code windows, Claude Desktop + IDE, etc.). Public API unchanged. (#32)
-- **NEW**: Opt-in single-instance guard via `KNOWLEDGE_RAG_SINGLE_INSTANCE=1` env var. **OFF by default** — multi-client MCP usage continues to work unchanged. When enabled, a second server process for the same `data_dir` exits with code 75 (`EX_TEMPFAIL`). Includes stale-PID recovery and SIGINT/SIGTERM handlers. See [docs/single-instance.md](docs/single-instance.md). (#33, original concept by @Hohlas in #31)
-- **NEW**: `examples/mcp-config-single-instance.json` — sample MCP client config for the opt-in guard.
-- **DOCS**: New `docs/single-instance.md` — when to use, when NOT to use, troubleshooting, full activation reference.
-- **DOCS**: README troubleshooting section for "Multiple MCP clients spawn duplicate servers" + memory-usage note for lazy embeddings.
-- **CHORE**: Sync version across `pyproject.toml`, `mcp_server/__init__.py`, and `npm/package.json` (was drifting since v3.5.x).
-- **CHORE**: pytest `tmp_path_retention_count=1` to avoid Windows atexit cleanup race in CI.
-- **ROADMAP**: Tracked v4.0 shared-service architecture (one daemon, many thin MCP clients) as the long-term fix for multi-process resource duplication. (#34)
-### v3.6.2 (2026-04-23)
+## 🗺️ Recent releases
-- **INFRA**: NPM provenance attestation (SLSA supply chain security), full README on npm page
-- **DOCS**: Reorganize Installation section — add NPX and Docker install methods, update What's New to v3.6.0
+- **v4.8.5** (2026-08-13) — Enterprise observability: `/health` endpoint + opt-in JSON structured logging
+- **v4.8.4** (2026-08-13) — Patch: security + durability + defensive fixes
+- **v4.8.3** (2026-08-10) — Critical hotfix: nuclear-rebuild + smart-reindex hardening on 50k+ chunk corpora
+- **v4.8.2** (2026-08-10) — FTS5 lexical fast-path opt-in release
+- **v4.8.0** (2026-08-06) — Multilingual foundation + zero-downtime reindex
-### v3.6.0 (2026-04-23)
-- **NEW**: Multi-language code parsing — C (`.c`), C++ (`.cpp`/`.h`), JavaScript (`.js`/`.jsx`), TypeScript (`.ts`/`.tsx`) with per-language function/class/import extraction
-- **NEW**: XML parser (`.xml`) — root element and namespace metadata extraction
-- **NEW**: All 8 new formats default enabled — no config change needed
-- **NEW**: NPM wrapper (`npx knowledge-rag`) + Docker image (`ghcr.io/lyonzin/knowledge-rag`)
-- **NEW**: Automated release pipeline — PyPI (Trusted Publishing), NPM, Docker GHCR
-- **IMPROVED**: Code parser reports correct `language` metadata per file type (was hardcoded to `"python"` for all code files)
-### v3.5.2 (2026-04-16)
-- **NEW**: Auto-discovery of CUDA 12 DLLs from pip-installed NVIDIA packages — no manual PATH configuration needed
-- **NEW**: Graceful GPU→CPU fallback with `[WARN]` log when CUDA init fails (missing drivers, wrong version, etc.)
-- **FIX**: Explicit `CPUExecutionProvider` when `gpu: false` — eliminates noisy CUDA probe errors in logs
-- **FIX**: BASE_DIR resolution now correctly prefers directories with `config.yaml` over those with only `config.example.yaml` (fixes editable installs)
-### v3.5.1 (2026-04-16)
-- **FIX**: Removed Python upper bound constraint (`<3.13` → `>=3.11`). Python 3.13 and 3.14 now supported — onnxruntime ships wheels for both.
-### v3.5.0 (2026-04-16)
-- **NEW**: Optional GPU acceleration for ONNX embeddings — `pip install knowledge-rag[gpu]` + `models.embedding.gpu: true` in config. 5-10x faster indexing on NVIDIA GPUs with automatic CPU fallback.
-- **DOCS**: Supported formats table added to README (20 formats)
-### v3.4.3 (2026-04-16)
-- **FIX**: Correct stdout protection via save/restore pattern — `__init__.py` saves original stdout and redirects to stderr during init, `server.py main()` restores it before `mcp.run()`. v3.4.2's global redirect broke MCP JSON-RPC response channel.
-### v3.4.1 (2026-04-16)
-- **FIX**: `pip install knowledge-rag` now auto-detects project directory from venv location
-- **NEW**: `install.sh` — Linux/macOS installer with pip and from-source modes
-- **IMPROVED**: BASE_DIR resolution chain: env var → source dir → venv parent → CWD → fallback
-### v3.4.0 (2026-04-16)
-- **NEW**: `models_cache_dir` — persistent embedding model cache, prevents re-download after reboots
-- **NEW**: `exclude_patterns` — glob-based file/directory exclusion during indexing
-- **NEW**: Jupyter Notebook (.ipynb) parser — extracts markdown and code cell sources only
-- **NEW**: MCP stdout protection — redirects stdout to stderr before server start
-- **NEW**: File watcher resilience — graceful fallback when Linux inotify limits are reached
-- **NEW**: MetaTrader (.mq4, .mqh) support — opt-in code parsing
-- **NEW**: 23 new tests (exclude patterns, ipynb parser, stdout protection)
-- Community credit: [@Hohlas](https://github.com/Hohlas) ([PR #18](https://github.com/lyonzin/knowledge-rag/pull/18))
-### v3.3.x
-- **v3.3.2**: Full type validation on YAML config, bounds checking, version sync
-- **v3.3.1**: YAML null value crash fix, presets bundled in pip wheel, `knowledge-rag init` CLI
-- **v3.3.0**: YAML configuration system, 4 domain presets, generic use support
-### v3.2.x
-- **v3.2.4**: Symlink support with circular loop protection
-- **v3.2.3**: BASE_DIR smart detection for pip installs
-- **v3.2.2**: Plug-and-play pip install, `KNOWLEDGE_RAG_DIR` env var
-- **v3.2.1**: Auto-recovery from corrupted ChromaDB
-- **v3.2.0**: Parallel BM25 + Semantic search, adjacent chunk retrieval
-### v3.1.x
-- **v3.1.1**: Code block protection in markdown chunker, AAR category, 14 CVE aliases
-- **v3.1.0**: DOCX/XLSX/PPTX/CSV support, file watcher, MMR diversification, PyPI publish
-### v3.0.0 (2026-03-19)
-- Replaced Ollama with FastEmbed (ONNX in-process)
-- Cross-encoder reranking, markdown-aware chunking, query expansion
-- 6 new MCP tools (12 total), auto-migration from v2.x
-<details>
-<summary>v2.x and earlier</summary>
-- **v2.2.0**: `hybrid_alpha=0` skips Ollama, default changed from 0.5 to 0.3
-- **v2.1.0**: Mermaid architecture diagrams
-- **v2.0.0**: Hybrid search, RRF fusion, `hybrid_alpha` parameter
-- **v1.1.0**: Incremental indexing, query cache, chunk deduplication
-- **v1.0.1**: Auto-cleanup orphan folders, removed hardcoded paths
-- **v1.0.0**: Initial release
-</details>
----
-## Contributing
-1. Fork the repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
+**Full history:** [CHANGELOG.md →](CHANGELOG.md)
 ---
-## License
+## 📜 License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+**MIT License** — [LICENSE](LICENSE). Forever. No cloud upsell, no dual-licensing, no restrictive clauses. Fork it, sell derivatives, embed it in commercial products — the license does not care.
 ---
-## Acknowledgments
-- [ChromaDB](https://www.trychroma.com/) — Vector database
-- [FastEmbed](https://qdrant.github.io/fastembed/) — ONNX Runtime embeddings
-- [FastMCP](https://github.com/anthropics/mcp) — Model Context Protocol framework
-- [PyMuPDF](https://pymupdf.readthedocs.io/) — PDF parsing
-- [rank-bm25](https://github.com/dorianbrown/rank_bm25) — BM25 Okapi implementation
-- [Watchdog](https://github.com/gorakhargosh/watchdog) — File system monitoring
-- [python-docx](https://python-docx.readthedocs.io/) / [openpyxl](https://openpyxl.readthedocs.io/) / [python-pptx](https://python-pptx.readthedocs.io/) — Office document parsing
-- [PyYAML](https://pyyaml.org/) — YAML configuration parsing
-- [Beautiful Soup](https://www.crummy.com/software/BeautifulSoup/) — HTML parsing for URL ingestion
+## 🙏 Acknowledgments
----
-## Author
+Built on the shoulders of amazing open-source projects:
-**Lyon.**
+- [**Anthropic MCP**](https://modelcontextprotocol.io/) — Model Context Protocol spec + Python SDK
+- [**ChromaDB**](https://www.trychroma.com/) — vector database that just works
+- [**FastEmbed**](https://github.com/qdrant/fastembed) — ONNX embeddings, no PyTorch bloat
+- [**HuggingFace**](https://huggingface.co/) — model hosting + `Xenova/ms-marco-MiniLM-L-6-v2` cross-encoder
+- [**BAAI**](https://huggingface.co/BAAI) — the `bge-small-en-v1.5` embedding model
-Security Researcher | Developer
+**Community contributors:** [@Hohlas](https://github.com/Hohlas) · [@eeshsaxena](https://github.com/eeshsaxena) · Sergey Khokhlov · and everyone who filed issues or PRs.
 ---
 <div align="center">
-**[Back to Top](#knowledge-rag)**
+**Built by [Ailton Rocha (Lyon.)](https://github.com/lyonzin)** · Star ⭐ if this saves you time · [Report an issue](https://github.com/lyonzin/knowledge-rag/issues/new/choose) · [Contribute](CONTRIBUTING.md)
+*knowledge-rag — the MCP-first local RAG server for Claude Code, Cursor, Windsurf, and every AI agent.*
 </div>