rag CLAUDE.md

Project instructions for NVIDIA’s RAG Blueprint, a reference application that lets users ask questions about documents and retrieve relevant information before generating answers. It covers the Python backend, React and TypeScript frontend, deployment files, documentation, and tests.

In plain words
What is it for?
They help agents locate project components, install dependencies, run unit and integration tests, check Python code, and work with Docker Compose or Helm deployment files.
Why use it?
They give coding agents a map of the project and its development commands. This reduces guesswork when changing the backend, frontend, deployment setup, or tests.

Instructions file

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/nvidia-ai-blueprints/rag/claude-md
Clone the repo
git clone --depth 1 https://github.com/NVIDIA-AI-Blueprints/rag
Per session 1,215 This file is loaded in full into every session.
When invoked 1,215 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01215 $0.01215
Opus 5 $0.00607 $0.00607
Sonnet 5 $0.00243 $0.00243
Haiku 4.5 $0.00121 $0.00121

Measured yesterday against content hash 7691e7865729, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

rag CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 97 lines

How it starts

The opening of the file, as written. The whole thing — 97 lines — stays where its author put it; the contents beside it link to each section on GitHub.

NVIDIA RAG Blueprint

Reference implementation for a Retrieval Augmented Generation pipeline. Python 3.11+ backend (FastAPI + LangChain), React/TypeScript frontend, deployable via Docker Compose or Helm.

Project structure

src/nvidia_rag/
├── rag_server/        # RAG query/response server (FastAPI)
├── ingestor_server/   # Document ingestion server (FastAPI)
└── utils/             # Shared utilities
frontend/              # React + TypeScript UI (pnpm)
deploy/
├── compose/           # Docker Compose files and env configs
└── helm/              # Helm charts (standard + MIG-slicing)
docs/                  # User-facing documentation (Sphinx, RST/MD)
tests/
├── unit/              # No network calls allowed
└── integration/       # Network calls permitted
notebooks/             # Jupyter notebooks for evaluation and examples

Development commands

Backend (Python)

uv sync                              # Install all deps
# Optional: RAGAS benchmark CLI (see scripts/eval/README.md)
# uv sync --project scripts/eval
uv run pytest tests/unit/            # Unit tests
uv run pytest tests/integration/     # Integration tests
ruff check --fix src/                # Lint + autofix
ruff format src/                     # Format
pre-commit run --all-files           # Run all pre-commit hooks

Frontend (TypeScript)

cd frontend
pnpm install
pnpm run dev                         # Dev server
pnpm run lint                        # ESLint
pnpm exec tsc --noEmit               # Type check
pnpm run test:run                    # Tests

Code conventions

  • Python: Ruff for linting and formatting (line-length 88, double quotes, space indent). Config in pyproject.toml.
  • Type hints: Required on all function signatures.
  • Imports: Sorted by isort via Ruff. No in-function imports.
  • Tests: Mirror source tree (src/nvidia_rag/rag_server/server.pytests/unit/rag_server/test_server.py).
  • Frontend: ESLint + TypeScript strict mode. Function components with hooks.
  • Env files: deploy/compose/nvdev.env (NVIDIA-hosted NIMs) and deploy/compose/.env (self-hosted). These are the source of truth for Docker deployments — shell-only exports are lost on restart.

Read the full file on GitHub · 97 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 97 lines · 1,215 tokens per session scan A 7691e7865729

Subscribe to this mod's changes

rag CLAUDE.md is an instructions file published in the GitHub repository NVIDIA-AI-Blueprints/rag (752 stars, last pushed 12d ago), licensed Apache-2.0. It adds 1,215 tokens to every session, about $0.0061 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories