agentleFS
aegnticaegntic/compound-engineering/skills/create-agent-skills/SKILL.md

create-agent-skills

Skill1 starsChanged 5 months agoMITView on GitHub

Expert guidance for creating Claude Code skills and slash commands. Use when working with SKILL.md files, authoring new skills, improving existing skills, creating slash commands, or understanding skill structure and best practices.

8 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

14 rules. 0 are common, 7 are distinctive, and 7 are very specific to this project.

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 7

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No supporting files needed

    line 29
  2. Distinctive:

    Use YAML frontmatter + markdown body with standard markdown headings.

    line 41
  3. Very specific:

    All fields are optional. Only description is recommended.

    line 63
  4. Very specific:

    Use $ARGUMENTS placeholder for user input.

    line 93
  5. Very specific:

    Add context: fork to run in isolation.

    line 128
  6. Very specific:

    Keep SKILL.md under 500 lines.

    line 146
  7. Very specific:

    Keep references one level deep from SKILL.md.

    line 159
  8. Distinctive:

    Audit existing skill: - Check against best practices

    line 179
  9. Very specific:

    Add component: - Add workflow/reference/example

    line 180
  10. Distinctive:

    Ask: Is this a manual workflow (deploy, commit, triage) or background knowledge (conventions, patterns)?

    line 187
  11. Distinctive:

    Test with actual tasks, not test scenarios

    line 249
  12. Distinctive:

    Check auto-triggering by asking something that matches the description

    line 251
  13. Distinctive:

    XML tags in body: - Use standard markdown headings

    line 268
  14. Very specific:

    Deep nesting: - Keep references one level from SKILL.md

    line 270

“Common” is measured: kept by at least 6 in 10 of the 8 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 & Commands

This skill teaches how to create effective Claude Code skills following the official specification from code.claude.com/docs/en/skills.

Commands and Skills Are Now The Same Thing

Custom slash commands have been merged into skills. A file at .claude/commands/review.md and a skill at .claude/skills/review/SKILL.md both create /review and work the same way. Existing .claude/commands/ files keep working. Skills add optional features: a directory for supporting files, frontmatter to control invocation, and automatic context loading.

If a skill and a command share the same name, the skill takes precedence.

When To Create What

Use a command file (commands/name.md) when:

  • Simple, single-file workflow
  • No supporting files needed
  • Task-oriented action (deploy, commit, triage)

Use a skill directory (skills/name/SKILL.md) when:

  • Need supporting reference files, scripts, or templates
  • Background knowledge Claude should auto-load
  • Complex enough to benefit from progressive disclosure

Both use identical YAML frontmatter and markdown content format.

Standard Markdown Format

Use YAML frontmatter + markdown body with standard markdown headings. Keep it clean and direct.

---
name: my-skill-name
description: What it does and when to use it
---

# My Skill Name

## Quick Start
Immediate actionable guidance...

## Instructions
Step-by-step procedures...

## Examples
Concrete usage examples...

Frontmatter Reference

All fields are optional. Only description is recommended.

FieldRequiredDescription
nameNoDisplay name. Lowercase letters, numbers, hyphens (max 64 chars). Defaults to directory name.
descriptionRecommendedWhat it does AND when to use it. Claude uses this for auto-discovery. Max 1024 chars.
argument-hintNoHint shown during autocomplete. Example: [issue-number]
disable-model-invocationNoSet true to prevent Claude auto-loading. Use for manual workflows like /deploy, /commit. Default: false.
user-invocableNoSet false to hide from / menu. Use for background knowledge. Default: true.
allowed-toolsNoTools Claude can use without permission prompts. Example: Read, Bash(git *)
modelNoModel to use. Prefer explicit IDs. In this repo, default reasoning work to claude-sonnet-4.6, GPT code/review work to gpt-5.3-codex via platform overrides, and reserve claude-haiku-4.5 / gpt-5.4-mini for lightweight search or research tasks.
contextNoSet fork to run in isolated subagent context.
agentNoSubagent type when context: fork. Options: Explore, Plan, general-purpose, or custom agent name.

Invocation Control

FrontmatterUser can invokeClaude can invokeWhen loaded
(default)YesYesDescription always in context, full content loads when invoked
disable-model-invocation: trueYesNoDescription not in context, loads only when user invokes
user-invocable: falseNoYesDescription always in context, loads when relevant

Use disable-model-invocation: true for workflows with side effects: /deploy, /commit, /triage-prs, /send-slack-message. You don't want Claude deciding to deploy because your code looks ready.

Use user-invocable: false for background knowledge that isn't a meaningful user action: coding conventions, domain context, legacy system docs.

Dynamic Features

Arguments

Use $ARGUMENTS placeholder for user input. If not present in content, arguments are appended automatically.

---
name: fix-issue
description: Fix a GitHub issue
disable-model-invocation: true
---

Fix GitHub issue $ARGUMENTS following our coding standards.

Access individual args: $ARGUMENTS[0] or shorthand $0, $1, $2.

Dynamic Context Injection

The !`command` syntax runs shell commands before content is sent to Claude:

---
name: pr-summary
description: Summarize changes in a pull request
context: fork
agent: Explore
---

## Context
- Branch diff: !`git diff main...HEAD`
- Changed files: !`git diff --name-only main...HEAD`

Summarize this pull request...

Running in a Subagent

Add context: fork to run in isolation. The skill content becomes the subagent's prompt. It won't have conversation history.

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

Research $ARGUMENTS thoroughly:
1. Find relevant files
2. Analyze the code
3. Summarize findings

Progressive Disclosure

Keep SKILL.md under 500 lines. Split detailed content into reference files:

my-skill/
├── SKILL.md           # Entry point (required, overview + navigation)
├── reference.md       # Detailed docs (loaded when needed)
├── examples.md        # Usage examples (loaded when needed)
└── scripts/
    └── helper.py      # Utility script (executed, not loaded)

Link from SKILL.md: For API details, see [reference.md](reference.md).

Keep references one level deep from SKILL.md. Avoid nested chains.

Effective Descriptions

The description enables skill discovery. Include both what it does and when to use it.

Good:

description: Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.

Bad:

description: Helps with documents

What Would You Like To Do?

  1. Create new skill - Build from scratch
  2. Create new command - Build a slash command
  3. Audit existing skill - Check against best practices
  4. Add component - Add workflow/reference/example
  5. Get guidance - Understand skill design

Creating a New Skill or Command

Step 1: Choose Type

Ask: Is this a manual workflow (deploy, commit, triage) or background knowledge (conventions, patterns)?

  • Manual workflow → command with disable-model-invocation: true
  • Background knowledge → skill without disable-model-invocation
  • Complex with supporting files → skill directory

Step 2: Create the File

Command:

---
name: my-command
description: What this command does
argument-hint: [expected arguments]
disable-model-invocation: true
allowed-tools: Bash(gh *), Read
---

# Command Title

## Workflow

### Step 1: Gather Context
...

### Step 2: Execute
...

## Success Criteria
- [ ] Expected outcome 1
- [ ] Expected outcome 2

Skill:

---
name: my-skill
description: What it does. Use when [trigger conditions].
---

# Skill Title

## Quick Start
[Immediate actionable example]

## Instructions
[Core guidance]

## Examples
[Concrete input/output pairs]

Step 3: Add Reference Files (If Needed)

Link from SKILL.md to detailed content:

For API reference, see [reference.md](reference.md).
For form filling guide, see [forms.md](forms.md).

Step 4: Test With Real Usage

  1. Test with actual tasks, not test scenarios
  2. Invoke directly with /skill-name to verify
  3. Check auto-triggering by asking something that matches the description
  4. Refine based on real behavior

Audit Checklist

  • Valid YAML frontmatter (name + description)
  • Description includes trigger keywords and is specific
  • Uses standard markdown headings (not XML tags)
  • SKILL.md under 500 lines
  • disable-model-invocation: true if it has side effects
  • allowed-tools set if specific tools needed
  • References one level deep, properly linked
  • Examples are concrete, not abstract
  • Tested with real usage

Anti-Patterns to Avoid

  • XML tags in body - Use standard markdown headings
  • Vague descriptions - Be specific with trigger keywords
  • Deep nesting - Keep references one level from SKILL.md
  • Missing invocation control - Side-effect workflows need disable-model-invocation: true
  • Too many options - Provide a default with escape hatch
  • Punting to Claude - Scripts should handle errors explicitly

Reference Files

For detailed guidance, see:

  • official-spec.md - Official skill specification
  • best-practices.md - Skill authoring best practices

Sources

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.