context7.json

{
  "$schema": "https://context7.com/schema/context7.json",
  "projectTitle": "Ragmir",
  "description": "Open-source retrieval for agentic RAG: local document search and exact citations through TypeScript, CLI, and MCP. Your agent plans and generates with a local, self-hosted, or cloud model.",
  "excludeFolders": [
    "node_modules",
    "packages/ragmir-core/dist",
    "packages/ragmir-landing/dist",
    "packages/ragmir-landing/.astro",
    "packages/ragmir-core/examples",
    "coverage",
    "release-artifacts",
    "private",
    ".ragmir",
    ".gitnexus",
    ".git"
  ],
  "excludeFiles": ["CHANGELOG.md", "pnpm-lock.yaml"],
  "rules": [
    "Ragmir is licensed AGPL-3.0-only from v3.0.0, with separate commercial licensing. Earlier releases keep their published license.",
    "Use the canonical setup prompt in docs/quick-start.md. Inspect existing sources and respect already authorized changes.",
    "Ragmir supplies local evidence for agentic RAG. The consuming agent owns query planning, synthesis, tool use, and actions.",
    "Show four workflows: build a feature, diagnose an incident, and plan a migration with Claude Code or Codex; make a confidential architecture decision with a local or self-hosted chat and model. Keep model destination and evidence flow explicit.",
    "The only executable is rgr. MCP exposes ragmir_status, ragmir_search, ragmir_expand, and ragmir_audit plus ragmir://context and ragmir://sources.",
    "Search returns three compact citations by default over MCP. Expand selected citations and refine queries in the host agent.",
    "Local-hash needs no model or API key. Semantic retrieval explicitly installs the optional @huggingface/transformers peer and preloads a pinned local model.",
    "Ragmir preserves selected source text without masking. The consumer decides whether excerpts go to a local model, a self-hosted server, or a cloud provider. Confidentiality also depends on the client, access, network, and logs. Keep credentials excluded at source selection.",
    "Keep .ragmir state private and ignored. Resolve data from the caller project. In monorepos use rgr bases and --project-root to verify routing.",
    "Use one createRagmirClient per project in a long-running process and close it at shutdown. Top-level functions suit one-shot scripts.",
    "Ragmir has no HTTP server. Hosts own transport security, authentication, authorization, and rate limits.",
    "Ingestion is bounded and resumable. Rebuilds stage validated replacements and activate atomically while preserving the previous index on failure.",
    "Use rgr upgrade --check after updating, then rgr upgrade. Retired keys are explicitly migrated with a private backup; changed policies require a staged rebuild.",
    "Keep local PDF OCR: configured executables process blank pages only, with bounded batches and private content-addressed caching. No cloud OCR.",
    "Use source-line citations only for text. PDF, Office, and EPUB use their native page, slide, sheet/cell, or spine coordinates.",
    "status and doctor compare files with the index by size and modification time on every run; doctor --deep and audit compare checksums. Missing manifests are never ready, and changed sources make coverage incomplete until the next ingest.",
    "Retain evaluate, preview, ranking explanation, source filters, optional metrics, storage maintenance, and per-project bounded workload queues.",
    "Share reviewed sources through existing Git or file-sharing workflows, then run rgr ingest on each workstation.",
    "Connect an MCP-capable chat or use the library example in docs/agent-integration.md with local Ollama, a self-hosted model endpoint, or a compatible cloud API. The host runs the agent loop and generation.",
    "Register the MCP server per project. Its instructions name the base; unrelated workspaces get a scope notice, or a refusal with mcpAllowedRoots. rgr doctor warns about user-scope and unapproved registrations.",
    "MCP search accepts up to five related queries in one budget and returns passages already seen in the session as short stubs. Results carry sourceStatus when a cited file changed and weakEvidence when support is thin.",
    "Paths are cited with forward slashes and in Unicode NFC on Linux, macOS, and Windows; exclusions match decomposed and case-variant names. A committed ragmir.config.json holds shared settings and .ragmir/config.json overrides it locally."
  ]
}