[Index]

Model: data/AgentPlaybook

A reusable agent playbook that defines structured steps and workflows for systematic task execution

Model Details: data/AgentPlaybook

Title Description Details
Playbook ID * Unique system-wide identifier for the playbook (e.g., teams_call_quality)
  • Field Name: playbook_id
  • Type: String
  • Pattern: ^[a-z][a-z0-9_]*$
Name * Display name of the playbook
  • Field Name: name
  • Type: String
Description * Purpose and scope of the playbook
  • Field Name: description
  • Type: String
Enabled Whether this playbook is currently active and available for use Default: True
  • Field Name: enabled
  • Type: Boolean
  • Default: True
Applicability Criteria Keywords and patterns indicating when this playbook is relevant
  • Field Name: applicability_criteria.[n]
  • Type: Array
Required Inputs List of required inputs for this playbook to execute
  • Field Name: required_inputs.[n]
  • Type: Array
Required Datasources List of required datasources for this playbook to execute
  • Field Name: required_datasources.[n]
  • Type: Array
Steps List of diagnostic steps to execute
  • Field Name: steps.[n]
  • Type: Array
Goal * What this step aims to achieve
  • Field Name: steps.[n].goal
  • Type: String
Rationale * Why this step is needed
  • Field Name: steps.[n].rationale
  • Type: String
Exit on Failure If true, stop execution immediately when this step fails after all retry attempts. If false, continue to next step even if this one fails.
  • Field Name: steps.[n].exit_on_failure
  • Type: Boolean
Parallel Execution If true, this step can execute in parallel with the next step. Steps marked as parallel will be grouped together and executed concurrently for improved performance.
  • Field Name: steps.[n].parallel
  • Type: Boolean
Presentation Schema Output format definition including sections and fields
  • Field Name: presentation_schema
  • Type: Object
Type * The type of presentation format
  • Field Name: presentation_schema.type
  • Type: String
  • Choices: ["Narrative - Structured narrative format with sections"]
Sections List of sections in the presentation
  • Field Name: sections.[n]
  • Type: Array
Header * Section header/title
  • Field Name: presentation_schema.sections.[n].header
  • Type: String
Description Description of what this section contains
  • Field Name: presentation_schema.sections.[n].description
  • Type: String
Note Additional notes about the presentation format
  • Field Name: presentation_schema.note
  • Type: String
Tags Additional tags for categorization
  • Field Name: tags.[n]
  • Type: Array