Skip to content

Schema

The structural contract for canonical pattern YAML lives in the JSON Schema below.

Reference

Top-level properties

  • id: Stable canonical identifier in lower-kebab-case.
  • slug: Path-safe human-readable identifier, typically aligned with id.
  • name: Display name for the pattern.
  • summary: Compact explanation of the reusable workflow pattern.
  • pattern_family: Primary pattern family. Keep values compatible with a future controlled vocabulary rather than relying on Phase 1 enums.
  • problem_structure: Primary reusable problem structure, designed to map to a later controlled vocabulary.
  • domain: One or more domains where the pattern commonly appears. Values should stay vocabulary-friendly.
  • workflow_goal: Statement of what successful execution achieves.
  • inputs: Structured description of workflow inputs.
  • outputs: Structured description of workflow outputs.
  • environment: Operating context, systems, actors, and important constraints.
  • capability_requirements: Capabilities required by the pattern. Capability names should later align with a controlled vocabulary.
  • execution_architecture: Architectural styles commonly used to realize the pattern. These entries should remain compatible with future architecture vocabularies.
  • autonomy_profile: Autonomy level, checkpoints, escalation rules, and reversibility expectations.
  • risk_governance: Risk posture and governance controls for the pattern. Level values are expected to align with later vocabulary files.
  • why_agentic: Reasons the workflow benefits from agentic behavior rather than static automation.
  • failure_modes: Known failure modes and mitigation expectations.
  • evaluation: How the pattern should be evaluated for quality, robustness, and control effectiveness.
  • implementation_notes: Optional implementation-oriented notes. Keep concrete examples here only when they clarify realization rather than redefining the pattern.
  • related_patterns: Optional references to adjacent, prerequisite, or contrastive patterns.
  • example_domains: Optional short examples showing how the pattern appears in different domains.
  • maturity: Pattern maturity indicator. Leave open for a future controlled vocabulary rather than hardcoding many statuses now.
  • tags: Freeform discovery tags in lower-kebab-case.