Example Skill
Purpose
Provide a spec-aligned template for creating consistent, reusable skills.
When to use
- You are adding a new skill to this repository.
- You want a starter structure with required sections.
Workflow
- State the objective in one sentence.
- Collect only required inputs.
- Execute deterministic steps.
- Load deeper context only when needed:
references/REFERENCE.mdassets/output-template.mdagents/openai.yaml
- Return output in a stable format.
- Use
scripts/example-check.shfor a deterministic preflight check.
Inputs
- Task objective
- Constraints
- Output destination
Outputs
- Primary deliverable
- Follow-up checks
Examples
- Build a new skill skeleton with required sections and valid frontmatter.
- Refactor an existing skill to move deep details into
references/. - Add deterministic checks under
scripts/for repeatable verification.
Edge cases
- Missing frontmatter fields: stop and add required fields first.
- Invalid
nameformat: normalize to lowercase-hyphen and match directory name. - Broken resource paths: fix links so all referenced files exist.
Guardrails
- Keep instructions concrete and testable.
- Avoid unnecessary context loading.
- Prefer deterministic commands over manual steps.
- Keep file references one level deep from
SKILL.md.