Workflow Configuration
Workflow templates are described with YAML. The editor uses YAML as the only data source, and stage preview, append, delete, reorder, and Agent selection all write back to the YAML string.
Basic Structure
yaml
name: Minimal implementation
description: Only includes the apply stage and implements changes from the proposal
version: 1
stages:
- id: stage-proposal-apply
name: Apply change
type: proposal-apply
agent: codex-acp
prompt: Implement code changes according to the approved proposal tasks.
when: Proposal is ready to apply
onFailure: Stop later stages
mcp: []
skills: []Top-Level Fields
| Field | Type | Description |
|---|---|---|
name | string | Workflow name |
description | string | Workflow description |
version | number | Template version |
stages | array | Stage list |
Stage Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique stage id. If omitted, ids such as stage-1 are generated by order. |
name | string | No | Display name. If omitted, id is used. |
type | string | No | Stage type. Unknown types are treated as custom. |
agent | string | No | ACP Agent id used by this stage. |
prompt | string | No | Stage execution instruction. |
when | string | No | Trigger condition description. |
onFailure | string | No | Failure handling description. |
mcp | string[] | No | MCP capabilities required by the stage. |
skills | string[] | No | Skills required by the stage. |
Stage Types
| Type | Description |
|---|---|
proposal-apply | Implement code changes according to approved proposal tasks. |
proposal-archive | Summarize execution results and archive the proposal. |
code-review | Review correctness, maintainability, and test coverage of the current change. |
security-check | Check dependencies, permissions, secrets, and potential security risks. |
create-pr | Prepare change summary, verification results, risk notes, and create a PR. |
custom | Custom stage. |
Compatibility handling: old value apply is parsed as proposal-apply, and old value archive is parsed as proposal-archive.
Save Rules
- Custom templates can be saved directly.
- Saving a built-in template creates a custom copy.
- Invalid YAML syntax blocks saving and shows a parse error.
- Built-in templates do not show a delete entry.
- Custom templates can be deleted from the detail page or sidebar.