agentleFS
Wsh7AshWsh7Ash/skillmcp/skills/skill-frontmatter-contract/SKILL.md

skill-frontmatter-contract

Skill0 starsChanged 15 days agoMITView on GitHub

Keep the frontmatter fields identical across a pack so any loader can index it without special cases. Use when skills from several packs will be loaded by one runtime or one index

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 3 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Ensure description carries both the summary and the use-when clause

    line 23
  2. Distinctive:

    Check every file parses as YAML with the expected types

    line 24
  3. Very specific:

    every SKILL.md has the same field names in the same order

    line 29
  4. Distinctive:

    every skill file declares the identical field set

    line 62

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
SKILL.md

Skill Frontmatter Contract

Keep the frontmatter fields identical across a pack so any loader can index it without special cases

Use when: skills from several packs will be loaded by one runtime or one index

Avoid when: the pack is a private draft that no loader will read

Procedure

  1. Fix the field set: name, description, pack, version, category, tags
  2. Generate the block from one renderer rather than by hand
  3. Assert the field set in the validator
  4. Ensure description carries both the summary and the use-when clause
  5. Check every file parses as YAML with the expected types
  6. Reject a file whose frontmatter drifts from the contract

Signals

  • every SKILL.md has the same field names in the same order
  • tags parse as a list of strings
  • the description is long enough to be useful and within the limit
  • the validator fails on a missing field

Patterns

1. Field set

name, description, pack, version, category, tags

2. Description

summary plus 'Use when ...' clause

3. Validator

reject a file missing any declared key

Pitfalls

  • Hand-writing frontmatter so fields drift between files
  • Putting a path in the description, which varies by machine
  • Letting the description grow past what a loader will display

Done when

  • every skill file declares the identical field set
  • a missing field is a validation failure

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.