About agent-skill-authoring
A skill-authoring guide for agents and people creating, refining, splitting, or auditing agent skills. It follows the agentskills.io format and covers discovery, progressive disclosure, evaluation, and validation.
Key features
- 01Skill scoping and restructuring
- 02Description and metadata guidance
- 03Progressive disclosure and reference routing
- 04Skill adoption evaluation design
- 05Audit checklists and validators
Use cases
- 01Create or restructure an agent skill
- 02Check discovery metadata and references
- 03Compare adoption of skill rule revisions
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ axross/ skills --skill agent-skill-authoringAfter installing, type/agent-skill-authoringin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/audit-checklist.mdbody-content-style.mdcapability-framing.mdcross-referencing.mddescription-writing.mdfrontmatter-and-naming.mdmarkdownlint-execution.mdprogressive-disclosure.mdproject-skill-archetypes.mdscoping-and-mece.mdskill-adoption-evaluation.mdscripts/check-links.mjscheck-skill-body.mjscheck-skill-frontmatter.mjscheck-skill-references.mjscommonmark.mjsguidelines.mjsskill-documents.mjstoken-estimate.mjsscripts/link-freshness/address-guard.mjscheck.mjsclassify.mjsurls.mjsscripts/markdownlint/cli.mjscontext.mjspackage.jsonrules.mjsrun.mjsDetails
From the project READMEAgent Skill Authoring
Use this capability whenever you create, refine, split, consolidate, rename, or audit an agent skill, or design an evaluation of its adoption. It turns a durable convention into a well-formed, discoverable skill and gives authors comparison contracts for evaluating rule revisions without confusing evidence of different behaviors.
Skills authored here follow the agentskills.io format. For the host project's active skill inventory and topic-to-skill routing, defer to each skill's own description discovery metadata and the directory listing under the skill root; where a host also maintains a written index (e.g. AGENTS.md), keep it in sync too.
Guidelines:
- MUST run the bundled validator that owns what a change touched —
scripts/check-skill-frontmatter.mjsafter editing frontmatter,scripts/check-skill-body.mjsafter editing prose,scripts/check-skill-references.mjsafter adding, moving, or renaming a reference file — and all three when unsure; together they are the enforcement path for the frontmatter, naming, discovery length-cap, and reference-linkage rules this skill states nowhere else (see audit-checklist.md). - SHOULD propose or implement a skill update when any task exposes a reusable convention, outdated guidance, a recurring review issue, or a missing project rule — skill maintenance happens when work reveals durable learning, not after every narrow fix.
- SHOULD skip skill maintenance when the work produced no generalizable learning, and state that it was skipped.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Scoping and MECE
See scoping-and-mece.md for:
- choosing a coherent skill boundary, skill name, split, consolidation, or source-of-truth location
- checking overlap with neighboring skills before adding new guidance
- separating portable judgment and workflow meaning from project policy, host execution, and skill distribution
- classifying mixed paragraphs and references before migrating their detailed rules
- classifying every section as mechanism or judgment when a vendor- or runner-specific skill sits beneath a tool-agnostic owner
- using section length and topic growth as signals for restructuring
Capability Framing
See capability-framing.md for:
- framing a skill as an ability the agent gains rather than a document it reads
- naming the activity a skill enables, and the document-style suffixes to avoid
- the voice of the
descriptionopening clause, the H1, and the opening paragraph - recasting an existing guideline-style skill in a fixed order, without changing what it requires
Frontmatter and Naming
See frontmatter-and-naming.md for:
- creating or editing discovery-critical
SKILL.mdfrontmatter - distinguishing standard required and optional metadata from host-specific invocation controls
- choosing the skill directory name and keeping it aligned with the
namefield - assessing host-project harness fields against the selected host and distribution path
Description Writing
See description-writing.md for:
- drafting, trimming, or auditing the
descriptionfield against its byte cap - the four-slot contract — trigger, identity, boundary, coverage — and why only the last may be sacrificed to a host's listing truncation
- fusing the trigger and the identity into one opening clause, and the two half-clauses that fail on their own: a bare token list, and "The ability to …"
- stating the surfaces a skill refuses to serve, alongside the hand-offs that route a competing skill away
- adding likely user phrasings and symptom-based triggers without over-broadening the skill
- the ~640-byte corpus mean the target names, and why it is a centre of gravity rather than a per-skill ceiling
Body Content Style
See body-content-style.md for:
- writing or revising substantive skill-body or reference-file sections
- balancing concise topic explanation, examples, and guideline bullets
- citing the upstream documentation URL in a section that pins a version or mirrors a vendor's option surface
- placing normative RFC-2119 requirement bullets in detailed reference content rather than parent routing sections
Progressive Disclosure
A SKILL.md carries exactly three things: what capability this is, the rules that apply unconditionally within it, and the routing that says which reference to read when. Every other normative statement — the detail behind a MUST or SHOULD, procedures, tables, examples — goes in a reference. The test for keeping a rule in the body is whether the reader needs it before the routing decision, not whether the rule is important: a change-loop capability's distinction between read-only work and a change must be available before the reader chooses an implementation reference. This contract is itself needed before the routing decision it governs, which is why it is stated here rather than left behind the pointer below — the same reason the load-bearing test just after it is stated directly rather than deferred.
A rule is load-bearing when an agent that loads SKILL.md and opens no reference would produce wrong output for want of it. Its statement stays in the owning reference; the parent routing names the situations in which that reference applies. Repeating those situations as a separate MUST-read bullet adds no selection information. Routing therefore consists only of a See ... for: or See ... when link and descriptive situation bullets, without a **Guidelines:** block.
Guidelines:
- MUST treat a rule as load-bearing when an agent that loads
SKILL.mdalone would produce wrong output for want of it — a fixed order, a closed set, or a constraint whose violation is not self-evident from the output — and as elaboration otherwise. - MUST place a load-bearing rule's own statement, its RFC-2119 bullets, and everything that elaborates it in the reference file that governs it, not in
SKILL.md. - MUST limit reference routing to a
See ... for:orSee ... whenlink followed by descriptive bullets naming situations, use cases, or conditions for consulting that reference. - MUST NOT attach a
**Guidelines:**block to reference routing, even for an empty block or one containing only read obligations; express reference-selection conditions in the descriptive bullets instead. - MUST NOT restate a load-bearing rule's statement or its RFC-2119 bullets in
SKILL.mdonce its reference states them, except under the carve-out below. - MUST keep a rule's own statement in
SKILL.md, never moved to a reference, when the rule's triggering condition is unconditional within its own skill's scope — a pointer that would fire on every turn costs a read and shakes nothing.
See progressive-disclosure.md for:
- deciding when a skill should stay single-file or split into
references/ - the three-part role contract and the "needed before the routing decision" test in full, and how the load-bearing test and the unconditional-scope carve-out relate to it
- the load-bearing test's full sorting table and the selection conditions a reference's routing names
- the size thresholds that signal a skill or reference file has grown too large
- using the descriptive-only parent routing-section format when splitting a skill or restructuring its reference layout
- wording reference-selection conditions narrowly enough to skip irrelevant references
- stating the fact a routing bullet points at — the flag, limit, or rule by name — instead of announcing that one exists
- keeping parent routing bullets free of RFC-2119-style requirement keywords so they remain routing cues, not duplicated rules
- deciding where a body-resident rule belongs relative to a routing list
Cross-Referencing and Discovery
See cross-referencing.md for:
- adding, renaming, moving, deleting, or linking skills and reference files
- choosing one source of truth instead of copying detailed rules across skills
- using topic-based cross-skill references, verifying intra-skill relative links, and keeping skill discovery current (plus any written index a host maintains)
- routing only to applicable owners and hosts, including when an optional owner or project host document is absent
Project Skill Archetypes
See project-skill-archetypes.md for:
- creating the project-specific skills a scaffolding pass calls for: structure, component, and UI/design
- the three-way ownership triangle and each archetype's skeleton, topics checklist, or table patterns
- growing archetype skeletons with worked examples and mechanical boundary checks
Skill-Adoption Evaluation Design
See skill-adoption-evaluation.md for:
- designing a skill-adoption evaluation or comparing intentional rule revisions before execution
- freezing task, treatment, scorer, opportunity, and claim-scope contracts while keeping scorer answers out of actor material
- separating natural tasks from boundary controls and retaining incomplete and zero-applicable populations
- distinguishing synthetic report checks from live qualification, routing evidence sufficiency only to scope-covering QA practices, and retaining the review limitation otherwise
Auditing and Validation
See audit-checklist.md for:
- auditing multiple skills or reporting skill-tree quality
- running the three bundled structure validators —
check-skill-frontmatter.mjs,check-skill-body.mjs, andcheck-skill-references.mjs— and which kind of edit each one answers for - running the bundled link-freshness audit (
scripts/link-freshness/check.mjs) on a schedule to catch a cited vendor URL that has gone 404, why only a confirmed-dead link fails it, and why apull_requesttrigger on it is a request-forgery primitive - checking inventory, skill discovery, section anatomy, RFC-2119 bullets, topic-based cross-skill references, and relative links
- identifying overlap, stale assumptions, orphan references, and missing source-of-truth links
- applying the ownership and portability checklist without expanding a bounded change into a library-wide migration
Protected Markdownlint Execution
See markdownlint-execution.md for:
- installing the bundled native-ESM package in a consumer project without author-checkout imports
- declaring skill/collection roots, raw-source snapshots and focused partial checks
- running AS001 actual YAML and AS010 explicit fence closure without inline, configuration or ignore suppression
- distinguishing genuine advisories from loading/runtime failures and effective coverage gaps
- extending shared rule/context execution while retaining the existing structure and network audits