Documentation

Schema · Procedures

Procedures, patterns and playbooks

Where rules describe what to do, procedures and playbooks describe how to do it — step by step, with success and failure criteria an agent can check.

procedures

ts
interface Procedure {
  id: string;                    // proc_*
  name: string;
  objective: string;
  steps: {
    step: number;
    action: string;
    input_required: string;
    output_expected: string;
  }[];
  success_criteria: string;
  failure_criteria: string;
}

patterns

ts
interface Pattern {
  id: string;                    // pat_*
  name: string;
  observed_when: string;
  signal: string;
  underlying_mechanism: string;
  response_strategy: string;
  confidence: number;
}

anti_patterns

ts
interface AntiPattern {
  id: string;                    // ant_*
  name: string;
  description: string;
  why_it_fails: string;
  warning_signals: string;
  replacement_behavior: string;
}

playbooks

ts
interface Playbook {
  id: string;                    // pb_*
  name: string;
  objective: string;
  activation_context: string;
  steps: string[];
  agent_tone: string;
  tools_needed: string[];
  expected_output: string;
  failure_modes: string[];
}