agentleFS
redai-infraredai-infra/Relax/skills/creating-skills/SKILL.md

creating-skills

Skill647 starsChanged 59 days agoApache-2.0View on GitHub

Guide for creating Claude Code skills following Anthropic's

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 27 edited versions we read keep these.

  • 3

    Distinctive

    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:

    Only create scripts when they add value: complex multi-step processing, repeated code generation, deterministic reliability.

    line 119
  2. Very specific:

    Run a skill in isolated context with context: fork:

    line 146
  3. Distinctive:

    ALWAYS: write descriptions that include WHAT + WHEN triggers + capabilities

    line 174
  4. Very specific:

    ALWAYS: keep SKILL.md under 500 lines, split to references when approaching

    line 175
  5. Distinctive:

    NEVER: create wrapper scripts for single commands

    line 178

“Common” is measured: kept by at least 6 in 10 of the 27 edited versions of this file we could read. “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

Creating skills

Guide for creating Claude Code skills following Anthropic's official best practices.

Project skill layout

This project uses a unified skills/ directory at the repo root, symlinked into tool-specific config directories:

<project-root>/
├── skills/                  # Canonical location for all skills
│   ├── code-review/
│   ├── creating-skills/
│   ├── dev/
│   └── git-commit/
├── .opencode/
│   └── skills -> ../skills  # Symlink for OpenCode
└── .codewiz/
    └── skills -> ../skills  # Symlink for Codewiz

This way a single set of skill definitions is shared across multiple AI coding tools.

Quick start

# 1. Create skill directory (in the project's unified skills/ dir)
mkdir -p skills/<skill-name>

# 2. Create SKILL.md with frontmatter
cat > skills/<skill-name>/SKILL.md << 'EOF'
---
name: <skill-name>
description: <what it does>. Use when <triggers>. <capabilities>.
---

# <Skill title>

<instructions>
EOF

# 3. Add optional resources as needed
mkdir -p skills/<skill-name>/{scripts,references,assets}

# 4. Ensure symlinks exist (one-time setup per tool)
# ln -s ../skills .opencode/skills
# ln -s ../skills .codewiz/skills

SKILL.md structure

Frontmatter (YAML between --- markers)

FieldRequiredDescription
nameNoDisplay name. Defaults to directory name. Lowercase, hyphens, max 64 chars.
descriptionRecommendedWhat + when + capabilities. Max 1024 chars. Determines when Claude activates the skill.
allowed-toolsNoTools Claude can use without asking permission when skill is active.
argument-hintNoAutocomplete hint for arguments. Example: [issue-number]
disable-model-invocationNotrue to prevent auto-invocation (manual /name only).
user-invocableNofalse to hide from / menu (background knowledge only).
modelNoModel override when skill is active.
contextNofork to run in isolated subagent context.
agentNoSubagent type when context: fork. Built-in: Explore, Plan, general-purpose.
hooksNoLifecycle hooks scoped to this skill.

Invocation control matrix

ConfigurationUser can invokeClaude can invoke
(defaults)YesYes
disable-model-invocation: trueYesNo
user-invocable: falseNoYes

Description formula

<what it does>. Use when <triggers>. <capabilities>.

Include action verbs ("create", "handle"), user intent ("wants to", "needs to"), and domain keywords users would say.

Directory structure

skill-name/
├── SKILL.md          # Required: instructions (keep under 500 lines)
├── scripts/          # Optional: executable code (deterministic, token-efficient)
├── references/       # Optional: docs loaded into context on demand
└── assets/           # Optional: files used in output, NOT loaded into context
                      # (templates, images, fonts, boilerplate)

Progressive disclosure (3-level loading)

  1. Metadata (name + description) - always in context (~100 tokens per skill)
  2. SKILL.md body - loaded when skill triggers (keep under 5k words)
  3. Bundled resources - loaded as needed by Claude

Reference supporting files from SKILL.md so Claude knows they exist. Keep references one level deep. For files over 100 lines, include a table of contents.

Scripts vs references vs assets

TypePurposeLoaded into context?
scripts/Deterministic operations, complex processingNo (executed via bash)
references/Documentation Claude reads while workingYes, on demand
assets/Templates, images, fonts for outputNo (copied/used in output)

Only create scripts when they add value: complex multi-step processing, repeated code generation, deterministic reliability. Not for single-command wrappers.

Dynamic features

Context injection

Inject shell command output into skill content before loading:

## Recent commits
!`git log --oneline -5 2>/dev/null`

The output replaces the directive when the skill loads.

String substitutions

Pass arguments to skills invoked via /skill-name arg1 arg2:

VariableValue
$ARGUMENTSFull argument string
$ARGUMENTS[0], $ARGUMENTS[1]Individual arguments
$1, $2Shorthand for $ARGUMENTS[N]

Subagent execution

Run a skill in isolated context with context: fork:

---
name: deep-research
description: Research a topic thoroughly.
context: fork
agent: Explore
---

Degrees of freedom

Match specificity to the task's fragility:

LevelWhen to useExample
High (text instructions)Multiple valid approaches, context-dependent"Analyze the code and suggest improvements"
Medium (pseudocode/scripts with params)Preferred pattern exists, some variation OKScript with configurable parameters
Low (specific scripts, few params)Fragile operations, consistency criticalExact sequence of API calls

Naming conventions

  • Lowercase, hyphens between words, max 64 chars
  • Styles: gerund (processing-pdfs), noun phrase (github-pr-creation), prefixed group (github-pr-*)

Important rules

  • ALWAYS write descriptions that include WHAT + WHEN triggers + capabilities
  • ALWAYS keep SKILL.md under 500 lines, split to references when approaching
  • ALWAYS reference bundled files from SKILL.md so Claude discovers them
  • NEVER duplicate info between SKILL.md and reference files
  • NEVER create wrapper scripts for single commands
  • NEVER include extraneous files (README.md, CHANGELOG.md, INSTALLATION_GUIDE.md, QUICK_REFERENCE.md)
  • NEVER explain things Claude already knows (standard libraries, common tools, basic patterns)

References

  • references/official_best_practices.md - Principles, anti-patterns, quality checklist, testing
  • references/skill_examples.md - Concrete skill examples with new features

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.