Index of every page on this site: llms.txt
All skills
nvidia-nemo avatar

/guardrails-developer-guide

@5112cf1
by nvidia-nemonvidia-nemo/guardrails7.5k stars
904
Run it yourself

Routes NVIDIA NeMo Guardrails library product-usage questions to the canonical documentation. Use when users ask how to install, configure, integrate, evaluate, observe, deploy, troubleshoot, or use the NVIDIA NeMo Guardrails library. Trigger keywords - install guardrails, configure rails, guardrail catalog, Colang, Python API, LangChain, LangGraph, server, evaluate guardrails, tracing, metrics, Docker, troubleshooting.

  • 1 file
  • 4.1 KB
  • Apache-2
  • Updated 5 months ago
  • GitHub
Use this Skill: https://skilld.dev/gh/nvidia-nemo/guardrails/guardrails-developer-guide

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈113 tokens for metadata: the name and description. ≈911 when used: this file.

Description uses 5.7% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈452 characters, or 5.7%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Guardrails Developer Guide

Use this skill for product-usage questions about the NVIDIA NeMo Guardrails library. Do not restate full product documentation in this skill. Route the agent to the canonical docs and summarize the relevant guidance for the user's task.

Documentation Source Rule

Always use the Markdown documentation under https://docs.nvidia.com/nemo/guardrails/. Use llms.txt and page URLs ending in .md when loading documentation for agent context. When presenting references or citations to users, use the canonical human-readable docs links without .md.

Retrieval Order

  1. Prefer the docs MCP server when the client supports MCP. Use the NVIDIA NeMo Guardrails library docs MCP server documented on the published docs site.

  2. If MCP is not available, fetch the docs index:

    https://docs.nvidia.com/nemo/guardrails/llms.txt
  3. Use the index to locate the relevant page, then fetch the clean Markdown form of that page by using the page URL with .md.

  4. If the user is working in a cloned repository and remote docs are unavailable, fall back to local docs/**/*.mdx.

  5. If the user has the package installed, align docs to the installed nemoguardrails version when versioned docs are available. If the version cannot be determined, ask whether to use the latest docs.

Do Not Hardcode Staging

Use production docs as the canonical source. Use staging URLs only when the user explicitly asks to inspect staging or when validating migration behavior.

Intent Routing

Use this table to find the right docs area quickly.

User intent Docs area
Install or verify environment Get Started → Installation
Add harmful-content, jailbreak, topic, PII, self-check, fact-check, or agentic security rails Configure Guardrails → Guardrail Catalog
Configure config.yml, models, prompts, tracing, streaming, or exceptions Configure Guardrails → YAML schema and configuration reference
Write or debug Colang flows Configure Guardrails → Colang
Use Python APIs Run Guardrailed Inference → Python API
Run the Guardrails API server or actions server Run Guardrailed Inference → Guardrails API Server
Integrate with LangChain, LangGraph, RunnableRails, or tools Integration with Third-Party Libraries
Evaluate guardrails or run vulnerability scanning Evaluation
Configure tracing, metrics, or logging Observability
Deploy with Docker or NeMo microservice More Deployment Options
Troubleshoot errors Troubleshooting
Understand telemetry and privacy Resources → Telemetry and Privacy

Security And Credential Handling

  • Never ask users to paste real API keys, tokens, passwords, or provider credentials into chat.
  • Use placeholders such as <NVIDIA_API_KEY>, <OPENAI_API_KEY>, or <YOUR_ENDPOINT> in examples.
  • Explain where users should set secrets locally, such as shell environment variables, secret managers, local config, or provider dashboards.
  • Do not print, store, or echo secrets in generated commands or summaries.

Response Style

  • Start with the user's immediate task and the relevant doc source.
  • Give the smallest working path first.
  • Add production hardening, optional extras, or alternative integrations only when they are relevant.
  • When examples use live providers, remind contributors that tests must mock LLM and provider calls.

Related Skills

  • Use guardrails-developer-create-guardrails when creating or modifying a guardrails configuration. When editing this repository, follow AGENTS.md and any subtree AGENTS.md files that apply.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at 5112cf1. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 5 months ago

README badge

README badge for nvidia-nemo/guardrails/guardrails-developer-guide