agentleFS
Lethe044Lethe044/agentskill-kit/skills/skill-author/SKILL.md

skill-author

Skill48 starsChanged 17 days agoMITView on GitHub

Guides an agent through writing a good SKILL.md, covering the name, a description that triggers at the right time, concise instructions, bundled scripts and tests. Use when the user asks to create, improve or review an agent skill, or wants to turn a repeated task into a reusable skill.

23 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 18 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Collect real examples: Ask for two or three actual requests the skill should handle, and one it should not.

    line 24
  2. Very specific:

    Keep the file under 500 lines and move long reference material into references/.

    line 29
  3. Very specific:

    Check it: Run askit lint, askit scan and askit test, then askit score.

    line 33
  4. Distinctive:

    Prefer steps an agent can verify over general advice.

    line 44
  5. Distinctive:

    Do not repeat what the model already knows.

    line 47
  6. Distinctive:

    Never ask the agent to hide actions from the user or to ignore other instructions.

    line 48
  7. Very specific:

    If the user cannot give examples, write the description from the stated goal and mark the skill as a draft in metadata.

    line 63

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

A skill is a folder with a SKILL.md file. The agent reads the name and description of every installed skill and loads the full instructions only when a task matches. The description is therefore the most important line.

When to use

  • The user keeps repeating the same kind of task and wants it captured.
  • The user has a draft skill that never triggers, or triggers at the wrong time.
  • A skill needs a review before it is shared.

Workflow

  1. Collect real examples. Ask for two or three actual requests the skill should handle, and one it should not.
  2. Pick the name. Lowercase letters, digits and single hyphens, at most 64 characters, same as the folder name.
  3. Write the description. Third person, what it does and when to use it, under 1024 characters, no angle brackets. Include the words a user would actually type.
  4. Write the instructions. Short sections: when to use, steps, output format, one example, errors. Keep the file under 500 lines and move long reference material into references/.
  5. Add a script only when code is more reliable than prose (parsing, counting, validating). Use the standard library, read arguments or standard input, print JSON, and exit with a non-zero code on failure.
  6. Add tests as a cases.json file inside a tests folder: one happy path, one edge case, one error case at minimum.
  7. Check it. Run askit lint, askit scan and askit test, then askit score.

Description checklist

  • Does it start with a verb that says what the skill does?
  • Does it contain "Use when ..." with concrete triggers?
  • Would a different skill be a better match for any of these words?
  • Is it written as "Analyzes logs" and not "I analyze logs"?

Writing instructions

  • Prefer steps an agent can verify over general advice.
  • Tell the agent what to do when input is missing or unclear.
  • Show the output format once, with a real example.
  • Do not repeat what the model already knows. Spend words on what is specific to this task.
  • Never ask the agent to hide actions from the user or to ignore other instructions.

Layout

my-skill/
  SKILL.md
  scripts/        optional code the skill runs
  references/     optional long documents, linked from SKILL.md
  tests/          cases.json or test_*.py
  evals/          evals.json for checking model behaviour

Errors

If the user cannot give examples, write the description from the stated goal and mark the skill as a draft in metadata.

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.