agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/nvcf/ai-tooling/AGENTS.md

nvcf / ai-tooling

AGENTS.md261 starsChanged 9 days agoApache-2.0View on GitHub

This subtree contains public Agent Skills for NVIDIA Cloud Functions (NVCF). All skills must comply with the Agent Skills specification plus the repo-specific public skill metadata contract. This repository is compatible with the Vercel Skills CLI. Use this file as the authoring contract for every public skill in user/skills/ and dev/skills/. Keep private skills in the private subtree. When adding or editing a skill, keep the external skill spec fields at the top level of the frontmatter, retain the required…

The file

We split this AGENTS.md into the rules it gives an agent

11 rules. About 0 are common, 7 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this file as the authoring contract for every public skill in user/skills/ and dev/skills/.

    line 7
  2. Very specific:

    When adding or editing a skill, keep the external skill spec fields at the top level of the frontmatter, retain the required repo-specific …

    line 9
  3. Distinctive:

    Must not start or end with a hyphen

    line 108
  4. Very specific:

    Must not contain consecutive hyphens (--)

    line 109
  5. Distinctive:

    Must match the parent directory name exactly

    line 110
  6. Distinctive:

    When to use it (trigger phrases, keywords)

    line 117
  7. Very specific:

    Keep main SKILL.md under 500 lines

    line 127
  8. Distinctive:

    Document common edge cases

    line 132
  9. Distinctive:

    Before You Start - list required config, binaries, and access.

    line 136
  10. Distinctive:

    Use relative paths from the skill root:

    line 143
  11. Distinctive:

    Before committing changes, verify:

    line 153

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

Agent Skills Repository Guidelines

This subtree contains public Agent Skills for NVIDIA Cloud Functions (NVCF). All skills must comply with the Agent Skills specification plus the repo-specific public skill metadata contract. This repository is compatible with the Vercel Skills CLI.

Instructions

Use this file as the authoring contract for every public skill in user/skills/ and dev/skills/. Keep private skills in the private subtree.

When adding or editing a skill, keep the external skill spec fields at the top level of the frontmatter, retain the required repo-specific fields under metadata, and include a concise ## Instructions section in the body.

Skill Structure

Source skills live under user/skills/ or dev/skills/. Each skill must be in its own subdirectory containing a SKILL.md file. The directory name must match the name field in the frontmatter.

user/skills/
- user-skill-name/
  - SKILL.md

dev/skills/
- dev-skill-name/
  - SKILL.md

Public hook source scripts live under dev/hooks/. Do not place hook implementation scripts directly under .cursor/hooks/, .codex/hooks/, or .claude/hooks/; those root directories are fanouts only and must contain matching symlinks to dev/hooks/.

SKILL.md Format

Complete Frontmatter Template

---
name: skill-name
description: Clear description of what the skill does and when to use it. Include specific keywords to help agents identify relevant tasks.
license: MIT
compatibility: Requires NGC CLI installed and configured
author: "nvcf-core-eng <nvcf-core-eng@exchange.nvidia.com>"
version: "1.0.0"
tags:
  - ngc
  - nvcf
  - cli
  - cloud-infrastructure
  - skill
tools:
  - Shell
  - Read
  - Write
metadata:
  internal: false
  author: "nvcf-core-eng <nvcf-core-eng@exchange.nvidia.com>"
  version: "1.0"
  tags:
    - ngc
    - nvcf
    - relevant-tag
  languages:
    - bash
  frameworks:
    - ngc-cli
  domain: cloud-infrastructure
---

Required Fields

FieldTypeConstraints
namestring1-64 chars, lowercase, alphanumeric + hyphens, no leading/trailing/consecutive hyphens, must match directory name
descriptionstring1-1024 chars, must describe what AND when to use, include keywords for discoverability
authorstringAuthor name or team
versionstringSemantic version string
tagsarrayCategorization tags (recommend 1-5 items for top-level spec compatibility)
toolsarrayAgent tools required by the skill (for example Shell, Read, Write)

Optional Fields

FieldTypeDescription
licensestringLicense name or reference to bundled license file
compatibilitystringMax 500 chars. Environment requirements
metadataobjectRepo-specific public skill metadata fields (see below)

Public Skill Metadata Fields (Required)

These fields must be placed inside the metadata object:

FieldTypeDescriptionExample
internalbooleanMust be false for public skills in this subtreefalse
authorstringAuthor name and NVIDIA email"Your Name <your-email@nvidia.com>"
versionstringSkill version"1.0"
tagsarrayList of searchable tags["ngc", "nvcf", "cli"]
languagesarrayProgramming languages this skill applies to["bash", "python"]
frameworksarrayFrameworks or libraries this skill covers["ngc-cli"]
domainstringDomain or area of expertise"cloud-infrastructure"

Fields NOT to Include

  • alwaysApply - This is for rules, not skills
  • globs - This is for rules, not skills

Skills are invoked on-demand, not automatically applied like rules.

Name Validation Rules

  • Lowercase letters, numbers, and hyphens only (a-z, 0-9, -)
  • Must not start or end with a hyphen
  • Must not contain consecutive hyphens (--)
  • Must match the parent directory name exactly

Description Best Practices

Include:

  1. What the skill does (actions it enables)
  2. When to use it (trigger phrases, keywords)

Example:

description: Manage NVCF clusters via NGC CLI. Register, list, and delete clusters for function and task deployments. Use when registering clusters, managing cluster configurations, or when the user mentions ngc cf cluster, NVCF clusters, or cluster registration.

Body Content Guidelines

  • Keep main SKILL.md under 500 lines
  • Move detailed reference material to references/ directory
  • Include a concise ## Instructions section near the top of the body
  • Include step-by-step instructions
  • Provide command examples
  • Document common edge cases

Standard Sections for CLI Skills

  1. Before You Start - list required config, binaries, and access.
  2. Core Commands - primary operations with examples.
  3. Examples - real-world usage scenarios.
  4. Additional Resources - links to detailed docs or reference files.

File References

Use relative paths from the skill root:

For detailed examples, see [examples.md](examples.md).
For reference material, see [references/REFERENCE.md](references/REFERENCE.md).
Run the helper script: `python scripts/helper.py`

Validation Checklist

Before committing changes, verify:

  • name field matches directory name
  • name is lowercase with hyphens only
  • description includes what AND when to use
  • compatibility field is present
  • Top-level author is present
  • Top-level version is present and semantic
  • Top-level tags is present
  • Top-level tools is present
  • metadata.author includes name and NVIDIA email
  • metadata.version is present
  • metadata.tags array is populated
  • metadata.languages array is populated
  • metadata.frameworks array is populated
  • metadata.domain is set
  • File is under 500 lines
  • All relative links are valid
  • No alwaysApply or globs fields present
  • If editing nvcf-self-managed-cli or nvcf-self-managed-installation source files: run go generate ./internal/agentskill/... in src/clis/nvcf-cli and stage skilldata_generated.go

Skill Inventory

Root AGENTS.md is the fanout index for public and private dev skills exposed through .cursor/skills/, .codex/skills/, and .claude/skills/. Keep this file focused on the public skill authoring contract. Use README.md for the public catalog users browse in this subtree.

References

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.

Check your setup, free