name

playbook-creator

description

Guide for designing and creating high-quality, reusable workflows using the playbook tool group. Use this skill when: (1) You want to capture a successful multi-step process for future reuse, (2) A user asks to 'create a playbook' or 'automate this task', (3) You need to design a structured automation workflow with clear inputs, outputs, and success criteria. Triggers: 'create playbook', 'automate this process', 'design workflow'.

Playbook Creator

This skill provides a structured framework for designing and implementing High-Quality (HQ) reusable workflows. Playbooks transform transient task execution into persistent, repeatable automation.

Core Workflow

To create an effective playbook, follow these sequential steps:

1. Identify the Goal and Success Criteria

A high-quality playbook must have a specific, measurable objective.

Goal: What is the final state? (e.g., "Successfully deploy a React app to GitHub Pages")
Success Criteria: What artifacts prove success? (e.g., "A 200 OK response from the live URL", "A 'build/' directory exists")

2. Design Atomic Steps

Break down the task into the smallest possible units of work that map to available tools.

Each step should ideally call ONE tool.
Use the Pattern Reference for common task structures: workflow-patterns.md

3. Map Data Flow and Dependencies

Define how data moves between steps using outputVariable and requiredData.

outputVariable: Name the result of a step clearly (e.g., "extracted_source_code").
requiredData: List the names of variables from previous steps that this step needs as input.
Refer to the Schema Reference for JSON field details: playbook-schema.md

4. Implementation and Registration

Draft the playbook JSON using the playbook-template.json asset.
Call playbook__createPlaybook with your completed definition.
(Optional) Test the playbook immediately using playbook__selectPlaybook.

Best Practices

Granularity: Avoid monolithic steps. Granular steps allow for better error recovery and observability.
Explicit Success: Always define requiredArtifacts. This allows the system to verify completion automatically.
Traceability: Use meaningful IDs for stepId (e.g., "npm_install" instead of "step_1") and outputVariable names.

Quick Links

Playbook Creator

This skill provides a structured framework for designing and implementing High-Quality (HQ) reusable workflows. Playbooks transform transient task execution into persistent, repeatable automation.

Core Workflow

To create an effective playbook, follow these sequential steps:

1. Identify the Goal and Success Criteria

A high-quality playbook must have a specific, measurable objective.

Goal: What is the final state? (e.g., "Successfully deploy a React app to GitHub Pages")

Success Criteria: What artifacts prove success? (e.g., "A 200 OK response from the live URL", "A 'build/' directory exists")

2. Design Atomic Steps

Break down the task into the smallest possible units of work that map to available tools.

Each step should ideally call ONE tool.

Use the Pattern Reference for common task structures: workflow-patterns.md

3. Map Data Flow and Dependencies

Define how data moves between steps using outputVariable and requiredData.

outputVariable: Name the result of a step clearly (e.g., "extracted_source_code").

requiredData: List the names of variables from previous steps that this step needs as input.

Refer to the Schema Reference for JSON field details: playbook-schema.md

4. Implementation and Registration

Draft the playbook JSON using the playbook-template.json asset.

Call playbook__createPlaybook with your completed definition.

(Optional) Test the playbook immediately using playbook__selectPlaybook.

Best Practices

Granularity: Avoid monolithic steps. Granular steps allow for better error recovery and observability.

Explicit Success: Always define requiredArtifacts. This allows the system to verify completion automatically.

Traceability: Use meaningful IDs for stepId (e.g., "npm_install" instead of "step_1") and outputVariable names.

Quick Links