agentleFS
akijain2000akijain2000/skill-factory/authoring/SKILL.md

authoring

Skill4 starsChanged 2 months agoMITView on GitHub

Draft, review, evaluate, and improve SKILL.md files using a compiled knowledge base of best practices and anti-patterns. Use when writing a new skill, reviewing an existing one, measuring skill behavior, or debugging why a skill does not trigger.

4 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions4 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 4

    1. automagik-dev/genie★ 351same name
    2. namastexlabs/automagik-genie★ 351same name
    3. CrowdStrike/fusion-skills★ 29same name
    4. Firzus/agent-skills★ 4same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository3 other files it gives its agents.

The file

Show its rules and text

We split this skill into the rules it gives an agent

28 rules. 0 are common, 20 are distinctive, and 8 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 20

    Distinctive

    This author's own choices. Worth a look.

  • 8

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If no input provided, ask: "What should this skill do?

    line 29
  2. Very specific:

    Read the wiki index to understand what knowledge is available.

    line 33
  3. Very specific:

    Read the file wiki/INDEX.md.

    line 35
  4. Very specific:

    When adapting external material, read wiki/concepts/skill-supply-chain.md.

    line 76
  5. Distinctive:

    Check each of these (in order of importance):

    line 90
  6. Distinctive:

    If writing from scratch:

    line 108
  7. Distinctive:

    Start with the frontmatter (name + description first, get those right)

    line 109
  8. Distinctive:

    Write a concise overview (2-4 sentences)

    line 110
  9. Distinctive:

    Write "When to use" triggers (bullet points)

    line 111
  10. Distinctive:

    Write the main workflow (numbered steps)

    line 112
  11. Distinctive:

    Add examples (input/output pairs)

    line 113
  12. Distinctive:

    Check line count -- split to reference files if over 500

    line 114
  13. Distinctive:

    Run the automated validator:

    line 124
  14. Distinctive:

    If it fails, fix the issues and re-run until it passes.

    line 130
  15. Very specific:

    If helpful, read exemplary skills for inspiration.

    line 134
  16. Distinctive:

    Do not equate Step 6's static validator with behavioral proof.

    line 138
  17. Distinctive:

    Create 10-20 cases with positive triggers, adjacent negative controls, functional outcomes, and known failures.

    line 141
  18. Distinctive:

    Prefer deterministic checks and privacy-safe real traces.

    line 142
  19. Distinctive:

    Run the same model and harness with zero or one target skill in clean, host-isolated workspaces for 3-6 trials.

    line 144
  20. Distinctive:

    Keep failed or diagnostic evidence without weakening gates or mixing incompatible runs.

    line 147
  21. Distinctive:

    If a real isolated adapter is unavailable, label behavioral evaluation blocked.

    line 148
  22. Very specific:

    Use evals/README.md and run:

    line 150
  23. Very specific:

    If this session produced useful observations about skill authoring (a new anti-pattern, a useful pattern, a host-specific gotcha), create a …

    line 158
  24. Distinctive:

    Concise beats thorough: Only include what the agent doesn't already know.

    line 184
  25. Distinctive:

    Retire with evidence: Remove a capability skill when the repeated no-skill baseline catches up, but keep its eval suite.

    line 189
  26. Very specific:

    Progressive disclosure: Keep SKILL.md under 500 lines.

    line 192
  27. Distinctive:

    Run repository-relative commands from the Skill Factory root.

    line 197
  28. Very specific:

    Do not edit immutable raw/ captures to make a conclusion read better.

    line 199

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

Skill Authoring

A meta-skill that queries the Skill Factory wiki to help you write better SKILL.md files.

When to use

  • Writing a new skill from scratch (idea or rough draft)
  • Reviewing an existing skill for quality
  • Improving a skill's description (most common failure point)
  • Adapting a skill for a different host (Cursor, Codex, Claude Code)
  • Debugging why a skill doesn't trigger
  • Proving whether a skill improves outcomes over the no-skill baseline
  • Deciding whether a capability skill can be retired

Workflow

Step 1: Intake

Accept one of:

  • A draft SKILL.md (read the file)
  • A plain-English description of what the skill should do
  • An existing skill directory to review

If no input provided, ask: "What should this skill do? Describe in 1-2 sentences."

Step 2: Load the wiki index

Read the wiki index to understand what knowledge is available. All paths below are relative to the skill-factory root directory.

Read the file wiki/INDEX.md.

This is the master table of contents with one-line summaries. Use it to pick which articles to read next.

Step 3: Targeted retrieval

Based on the task, read the most relevant wiki articles. Do NOT read all of them. Pick 3-5:

Always read for any task:

  • wiki/research/anatomy-of-a-good-skill.md (the quality checklist)
  • wiki/concepts/description-writing.md (most common failure point)

Read if writing from scratch:

  • wiki/concepts/progressive-disclosure.md
  • wiki/concepts/naming-conventions.md
  • wiki/concepts/skill-discovery.md

Read if reviewing:

  • wiki/research/anti-patterns.md
  • wiki/concepts/token-budget.md

Read if the skill has scripts:

  • wiki/concepts/error-handling-in-scripts.md
  • wiki/concepts/validation-loops.md

Read if multi-host:

  • wiki/concepts/host-compatibility.md
  • wiki/research/host-differences.md

Read if the skill has complex workflows:

  • wiki/concepts/checklist-workflows.md
  • wiki/concepts/plan-validate-execute.md
  • wiki/concepts/template-patterns.md

Always read before calling a skill behaviorally validated:

  • wiki/concepts/skill-evaluations.md
  • wiki/concepts/evidence-lifecycle.md
  • evals/README.md

Step 3a: Review adopted source boundaries

When adapting external material, read wiki/concepts/skill-supply-chain.md. Pin the source revision and sampled paths, check the applicable license, and inspect scripts/hooks as well as prose. A repository HEAD change is a review trigger; a whole-package fingerprint detects changes outside SKILL.md.

For a skill used in a large catalog, read wiki/concepts/retrieval-and-interference.md. Keep ranking, actual activation, and task outcomes separate. Do not add source setup instructions to the active host without authorization.

Step 4: Gap analysis

Compare the draft against the quality spec. Read the file SKILL_SPEC.md.

Check each of these (in order of importance):

  1. Description quality -- Does it have a WHAT verb and a WHEN trigger? Third person? Under 1024 chars? Specific keywords?
  2. Name quality -- Lowercase, hyphens, matches directory, not vague?
  3. Body length -- Under 500 lines? If over, should it use progressive disclosure?
  4. Anti-patterns -- Read wiki/research/anti-patterns.md and check against each one
  5. Content necessity -- Is everything in the body something the agent doesn't already know?
  6. Examples -- Does it include concrete input/output examples?
  7. Consistency -- Consistent terminology throughout?
  8. Output format -- If the skill produces output, is the format specified?
  9. Routing evidence -- Are there natural positive and adjacent negative prompts?
  10. Outcome evidence -- Does an isolated, repeated skill-versus-baseline eval show a useful delta?
  11. No-ops -- Can generic directives be deleted without reducing eval performance?
  12. Pointers -- Does each disclosed reference name its distinct trigger branch? Keep shared invariants inline and branch-specific detail behind an explicit pointer.
  13. Execution contract -- If delegation is part of the authorized workflow, name foreground/background behavior, deadline, result schema, failure handling, and mutation owner for the actual host.

Step 5: Draft or rewrite

If writing from scratch:

  1. Start with the frontmatter (name + description first, get those right)
  2. Write a concise overview (2-4 sentences)
  3. Write "When to use" triggers (bullet points)
  4. Write the main workflow (numbered steps)
  5. Add examples (input/output pairs)
  6. Check line count -- split to reference files if over 500

If reviewing/improving:

  1. List every issue found in Step 4
  2. For each issue, show the current text and the proposed fix
  3. Apply all fixes
  4. Verify the result

Step 6: Validate

Run the automated validator:

bun run scripts/validate-skill.ts <path-to-skill-directory>

If it fails, fix the issues and re-run until it passes.

Step 7: Quality examples

If helpful, read exemplary skills for inspiration. List the files in wiki/examples/good/ and read the one most similar to the skill being authored.

Step 8: Behavioral evaluation

Do not equate Step 6's static validator with behavioral proof.

  1. Classify the skill as capability or preference, and model-triggered or user-invoked.
  2. Create 10-20 cases with positive triggers, adjacent negative controls, functional outcomes, and known failures.
  3. Prefer deterministic checks and privacy-safe real traces.
  4. Separate development and selection cases from an untouched final holdout. A set used to pick the best description is validation, even if upstream calls it test. Freeze thresholds, model/CLI identity, and evaluator/suite/skill/adapter fingerprints.
  5. Run the same model and harness with zero or one target skill in clean, host-isolated workspaces for 3-6 trials.
  6. Checkpoint normalized records, exclude raw trajectories/credentials, and clean disposable temp/auth state.
  7. Report trigger accuracy, skill and baseline outcome pass rates, delta, reliability, and exact evidence identity. Missing activation telemetry is unknown, not a successful negative control. Exclude eval answers and grader assets from agent-visible skill packages.
  8. Keep failed or diagnostic evidence without weakening gates or mixing incompatible runs.
  9. If a real isolated adapter is unavailable, label behavioral evaluation blocked; do not call the skill validated.

Use evals/README.md and run:

bun run scripts/evaluate-skill.ts evals/<suite>.json

Step 9: File insights back

If this session produced useful observations about skill authoring (a new anti-pattern, a useful pattern, a host-specific gotcha), create a new file at wiki/queries/observation-YYYYMMDD-TOPIC.md with this structure:

# Observation: [TITLE]
Date: [today's date]
Context: [what skill was being authored]

## Finding
[what was discovered]

## Recommendation
[how to apply this in future skills]

Step 10: Output

Deliver:

  1. The final SKILL.md (complete and structurally validated)
  2. A summary of changes made (if reviewing)
  3. Validation results (should be passing)
  4. Behavioral eval results, or an explicit blocked/not-run label
  5. Durable paths for the skill, references, eval definition, checkpoint/report, and any diagnostic evidence

Key principles (from the wiki)

  • Description is the #1 failure point. Get the WHAT verb + WHEN trigger right before anything else.
  • Concise beats thorough. Only include what the agent doesn't already know.
  • Defaults over menus. Pick one tool/approach, mention alternatives as escape hatch.
  • Procedures over declarations. Teach approach, not specific answers.
  • Test against real tasks. A skill that doesn't improve on the baseline isn't needed.
  • Evaluate outcomes, not paths. Preserve valid agent freedom while checking the final state and safety constraints.
  • Retire with evidence. Remove a capability skill when the repeated no-skill baseline catches up, but keep its eval suite.
  • Evidence has distinct homes. Active procedure, historical context, eval definitions, checkpoints, reports, and production proof are not interchangeable.
  • Failed evals are data. Retain them, fix named cases, and rerun under a new fingerprint without moving the gate.
  • Progressive disclosure. Keep SKILL.md under 500 lines. Split details into reference files.
  • Gotchas are gold. Environment-specific facts that defy assumptions are the highest-value content.

Gotchas

  • Run repository-relative commands from the Skill Factory root; an authoring target may live elsewhere, but the wiki, validator, and eval harness live here.
  • Do not edit immutable raw/ captures to make a conclusion read better. Update the canonical wiki or skill and preserve the source receipt.
  • Host credentials may make a live eval possible without making its output safe to commit. Persist normalized evidence only and clean disposable auth state.

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.