Home Schema

Workflow Brief Markdown Schema

Markdown section declaration and structural validator for the workflow-brief handoff.

draft meta

Revised: 2026-09-21
Rev: 1

schema workflow-brief @galaxy-foundry/gxwf-foundry @ 0.2.0

Markdown sections

One nonempty document title is required. Headings are case-insensitive. Counts apply within each parent; additional headings and arbitrary order are allowed.

Heading	Parent	Minimum	Maximum	Content
`## Workflow`	Document	1	1	Required when present
`### Objective`	Workflow	1	1	Required when present
`### Sources`	Workflow	0	1	Required when present
`### Scope`	Workflow	0	1	Required when present
`#### Included`	Workflow / Scope	0	1	Required when present
`#### Excluded`	Workflow / Scope	0	1	Required when present
`### Inputs and outputs`	Workflow	0	1	Required when present
`### Requirements and preferences`	Workflow	0	1	Required when present
`### Acceptance criteria`	Workflow	0	1	Required when present
`### Open questions`	Workflow	0	1	Required when present
`### Decisions`	Workflow	0	1	Required when present
`### Related artifacts`	Workflow	0	1	Required when present
`### Blockers`	Workflow	0	1	May be empty
`## Agent Environment`	Document	1	1	Required when present
`### Tooling`	Agent Environment	0	1	Required when present
`### Constraints`	Agent Environment	0	1	Required when present
`### Containerization`	Agent Environment	0	1	Required when present
`### Blockers`	Agent Environment	0	1	May be empty

Workflow Brief Markdown Schema

The package export workflowBriefSchema declares the required Markdown sections for a Workflow Brief. Casting copies the declaration into a schema sidecar and records foundry validate-workflow-brief as its artifact validator.

See workflow-brief-design for the document definition and markdown-document-contract for the shared declaration format. Structural validation accepts a brief with blockers so it can be reviewed. The harness separately runs foundry check-workflow-brief and stops before implementation on declared blockers; expert review and current preflight are also required.

Incoming References (2)

freeform-summary-to-workflow-brief schema of artifact output — Turn a freeform source summary and selected scope into a Workflow Brief without Galaxy design assumptions.
nextflow-summary-to-workflow-brief schema of artifact output — Turn a nextflow source summary and selected scope into a Workflow Brief without Galaxy design assumptions.