agentleFS
peterbamuhigirepeterbamuhigire/chwezi-dev-engine/skills/ai/ai-rag-patterns/SKILL.md

ai-rag-patterns

Skill31 starsChanged 18 days agoMITView on GitHub

Use when building features that answer questions from private data, documents, policies, or time-sensitive information — RAG architecture, chunking, hybrid search, re-ranking, vector databases, evaluation, agentic and multimodal RAG, and bounded iterative retrieval for context-starved subagents.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Default to read-only analysis.

    line 27
  2. Distinctive:

    When required telemetry, evidence, execution, network access, or write authority is unavailable, return a partial result with each …

    line 31
  3. Distinctive:

    Use when building features that answer questions from private data, documents, policies, or time-sensitive information — RAG architecture, …

    line 55
  4. Very specific:

    Use the references/ directory for deep detail after reading the core workflow below.

    line 66
  5. Very specific:

    When answers depend on structured records about a specific customer, order or account (not documents), or when embedding, prompt and model …

    line 141

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

RAG Patterns — Retrieval-Augmented Generation

Operating contract

Inputs

InputRequiredPurpose
Domain evidenceyesquestion set, authoritative corpus, tenancy and access rules, freshness target, citation needs, and evaluation set

Outputs

  • Produce: retrieval architecture, ingestion/chunking policy, index and filter contract, grounded-answer schema, and evaluation report.

Capability and permission boundaries

Default to read-only analysis. Read only scoped records; redact secrets and regulated data. Writes, execution, network calls, production configuration, customer communication, billing changes, and delegation require explicit authority and an identified owner. Never widen tenant, time-window, or system scope implicitly.

Degraded mode

When required telemetry, evidence, execution, network access, or write authority is unavailable, return a partial result with each unassessed item labelled, preserve the safest existing state, and state the evidence or approval needed to continue. Never convert missing evidence into a pass.

Decision rules

ConditionAction
Scope, owner, or threshold is missingStop the affected decision and request it
Evidence is incomplete but read-only analysis is safeProduce a qualified partial result and gap list
A mutation exceeds authority or tenant boundaryBlock it and route for approval
Evidence meets the stated thresholdIssue the output with provenance and owner

Anti-Patterns

  • Treating absent evidence as success. Fix: mark the check unassessed and name the missing source.
  • Expanding one tenant or workflow to all tenants. Fix: enforce supplied scope at every query and action.
  • Performing a production write during analysis. Fix: emit a reviewed change plan until authority is explicit.
  • Reporting a metric without population, window, or source. Fix: attach all three.
  • Hiding a failed threshold inside an average. Fix: report failure slices and the remediation owner.

Acknowledgement: Shared by Peter Bamuhigire, techguypeter.com, +256 784 464178.

<!-- dual-compat-start -->

Use When

  • Use when building features that answer questions from private data, documents, policies, or time-sensitive information — RAG architecture, chunking strategies, hybrid search, re-ranking, vector databases, evaluation, agentic RAG, multimodal RAG...

Evidence Produced

CategoryArtifactFormatExample
CorrectnessRAG retrieval evaluation reportMarkdown doc covering recall / precision / answer-quality on a fixed eval setdocs/ai/rag-eval-2026-04-16.md
Data safetyIndex ingestion + tenancy isolation noteMarkdown doc covering chunking, source filtering, and per-tenant index segregationdocs/ai/rag-tenancy-note.md

References

  • Use the references/ directory for deep detail after reading the core workflow below.
  • references/curated-corpus-worked-example.md: small curated corpus with BM25 ranking, per-domain score floors, calibrated abstention and a graded, fingerprinted golden set.
<!-- dual-compat-end -->

Overview

RAG solves the core LLM limitation: they only know what they were trained on. Use RAG to inject private data (invoices, menus, policies, reports) into every AI response.

Core principle: RAG = look up a database + LLM synthesises the results. The LLM never needs to "know" your data.


When to Use RAG

ConditionAction
Knowledge base < 200K tokens (~500 pages)Include everything in context — no RAG needed
Knowledge base > 200K tokensUse RAG
Data changes frequently (menus, prices, stock)RAG (update documents, not model)
Data is private/confidentialRAG (keeps data out of training pipelines)
Need source citationsRAG (chunks are traceable to source)
Model needs brand voice / domain jargonFine-tune instead

RAG vs Fine-Tuning

FactorRAGFine-Tuning
Up-to-date content✅ Yes (add docs anytime)❌ Stale until retrained
Hallucinations✅ Lower (document-grounded)❌ Higher
Source citations✅ Yes❌ No
Brand voice control❌ Weak✅ Strong
Domain jargon❌ Weak✅ Strong
Up-front cost✅ Lower❌ High

Default: start with RAG. Fine-tune only when RAG + prompt engineering cannot deliver the required tone or vocabulary.


Additional Guidance

Guidance is split across two reference files so this entrypoint stays compact.

references/skill-deep-dive.md — architecture, chunking, retrieval, schema:

  • Pipeline Architecture
  • Chunking Strategies
  • Embedding Model Selection
  • Vector Database Selection
  • Retrieval Algorithms
  • Re-Ranking
  • Full RAG Query Algorithm
  • Query Rewriting (Multi-Turn)
  • RAG Schema (Multi-Tenant)
  • Evaluation Framework
  • Production Patterns
  • Agentic RAG
  • Multimodal RAG, Edge Cases, Cost Optimisation, Sources

references/production-rag.md — the progression from draft to production and the gates before shipping:

  • RAG Maturity Model — Naive → Advanced → Modular
  • Query Transformation — HyDE, Multi-Query, Step-Back
  • Contextual Compression
  • Self-RAG
  • RAGAS Evaluation — 4 metrics with production thresholds
  • Embedding Pipeline — batching, upserts, re-embed triggers, $/1M-token table
  • Cost Management Decision Tree — concrete dollar figures per branch
  • Failure Mode Playbook — empty, irrelevant, hallucinated, stale
  • Gates Before Shipping

references/iterative-retrieval.md — load when a context-starved subagent must explore a codebase or workspace before working: bounded DISPATCH-EVALUATE-REFINE-LOOP (max 3 cycles), relevance banding, explicit gap lists, and terminology learning.

Load the production file when building a RAG system that has to pass evaluation gates, survive multi-tenant review, or hit a cost budget under load.

When answers depend on structured records about a specific customer, order or account (not documents), or when embedding, prompt and model versions must be managed like an ML system, load python-ml-predictive reference ml-system-architecture-fti.md (feature/training/inference pipelines, entity-keyed retrieval, version coupling).

Multi-Tenant Addendum

This skill describes RAG patterns in general. When the RAG feature ships inside a multi-tenant SaaS, the production answer is ai-rag-multi-tenant — per-tenant ingestion pipelines, vector store partitioning, tier-specific chunking and embedding models, defence-in-depth retrieval security, and citation grounding tied to live sources.

Cross-references:

  • ai-rag-multi-tenant — multi-tenant RAG end-to-end.
  • ai-tenant-isolation-patterns — vector-store partitioning tradeoffs and data-bleed tests.
  • ai-on-saas-architecture — KB service as a control-plane service.
  • ai-hallucination-slo-and-grounding — citation grounding + faithfulness SLO.
  • ai-model-gateway — gateway-mediated retrieval calls.
  • saas-tenant-data-portability-and-erasure — KB erasure cascade for embeddings.
  • Catalog metadata for AI — load when retrieval or an agent draws on data-catalog or data-contract metadata: classification-first filtering, ODCS context block, provenance.

Consolidated Child References

  • Load references/routing.md to map retired AI child skill slugs to their reference modules.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.