context7.json

{
  "$schema": "https://context7.com/schema/context7.json",
  "projectTitle": "Ragmir",
  "description": "Confidential local RAG for coding agents and scripts, with offline cited retrieval. The TypeScript CLI, library, read-focused MCP server, and portable skills keep the corpus and index under ignored local state. Optional local Chat and TTS remain separate packages.",
  "excludeFolders": [
    "node_modules",
    "packages/ragmir-core/dist",
    "packages/ragmir-tts/dist",
    "packages/ragmir-chat/dist",
    "packages/ragmir-landing/dist",
    "packages/ragmir-landing/.astro",
    "packages/ragmir-core/examples",
    "release-artifacts",
    "private",
    ".ragmir",
    ".gitnexus",
    ".git"
  ],
  "excludeFiles": ["CHANGELOG.md", "pnpm-lock.yaml"],
  "rules": [
    "Ragmir Core returns cited retrieval context only; it does not synthesize answers itself.",
    "Any compatible coding agent, script, CLI, TypeScript application, or MCP client can consume Core results; use a local consumer when no passage may leave the machine.",
    "Use one `createRagmirClient()` per project root for repeated work in a stateful Node.js process; close it during shutdown and use the top-level functions for one-shot scripts.",
    "Ragmir does not open an HTTP port; a network-facing host owns its transport, authentication, authorization, and rate limits.",
    "`rgr chat` is optional add-on generation via @jcode.labs/ragmir-chat; the core remains retrieval-only.",
    "Qwen and Gemma are optional Ragmir Chat profiles, never requirements of Core, the CLI, the TypeScript API, or MCP.",
    "The `local-hash` embedding provider (default) is a lexical sha256 embedding, not semantic; use `transformers` for semantic retrieval.",
    "Switching `embeddingProvider` requires `rgr ingest --rebuild`, since the two providers produce incompatible vectors.",
    "Ingestion commits resumable file batches under ignored `.ragmir/storage/` state; use `rgr status --json` for progress, and expect `--rebuild` to preserve the active index until a staged generation is validated.",
    "Run `rgr doctor --fix` after upgrading or misconfiguration to repair scaffolding, `.gitignore` entries, and the agent skill install.",
    "Config resolves from the caller's working directory (`.ragmir/config.json`), never from the package install path.",
    "In a monorepo, the nearest configured ancestor is active; use `rgr bases --json` or explicit `--project-root` to verify routing.",
    "Use `rgr preview` to inspect redacted chunks without writing an index, and `search(..., { explain: true })` only when rank diagnostics are needed.",
    "MCP resources `ragmir://context` and `ragmir://sources` are bounded agent-orientation surfaces; retrieval still happens through the read-focused tools."
  ]
}