ExecutionReviewed Markdown template

SKILL.md

Portable Agent Skill

Package one bounded, repeatable workflow with a discoverable trigger, explicit inputs and outputs, ordered instructions, edge-case handling, and validation. Keep supporting references and scripts inspectable.

Download SKILL.mdReview the fields

Discoverability

Valid Skill frontmatter included

---
name: example-skill
description: Performs one bounded, repeatable workflow. Use when the requested task matches the workflow described in this Skill.
metadata:
  version: "0.1.0"
---

Fillable structure

Replace prompts with project evidence.

Remove any field that does not apply. A smaller maintained file is more useful than generic documentation that agents and reviewers cannot trust.

  1. 01

    Trigger and outcome

    Make it easy for an agent to decide when the Skill applies and what successful completion means.

    • Use when: List the user phrases, file types, or task conditions that should activate this Skill

    • Do not use when: Name nearby tasks that require a different workflow or human judgment

    • Outcome: Describe the verifiable artifact or state this Skill produces

  2. 02

    Inputs and outputs

    Declare required context and a stable return contract before the procedure.

    • Required inputs: List files, parameters, credentials, and assumptions the workflow needs

    • Output contract: Define files, structured fields, messages, or evidence returned

    • Dependencies: List optional scripts, references, assets, tools, and environment requirements

  3. 03

    Procedure

    Write ordered steps with decision points, checkpoints, and the smallest safe tool scope.

    • Prepare: Describe read-only discovery and precondition checks

    • Execute: List the ordered implementation steps and allowed tools

    • Verify: State the checks that must pass before returning the result

  4. 04

    Failures and progressive disclosure

    Keep the main file focused while making recovery and deeper material discoverable.

    • Edge cases: List ambiguous, malformed, missing, or unsafe inputs and the required response

    • Recovery: Explain retry limits, cleanup, rollback, and escalation

    • References: Link focused files under references, scripts, or assets using relative paths

Related field guides

Primary references

Next template

ARCHITECTURE.md · Agent system architecture