Skip to content
Tools/Spec Introspection/list_playbooks

list_playbooks

List canonical UPG playbooks from `@unified-product-graph/core`. Each playbook bootstraps a region; its `creation_sequence` answers "what to create when populating this region". Filters: `region`, `canonical_only`, `framework_id`. The catalog spans 10 regions: one canonical playbook per region, plus specialised playbooks (three carry a `framework_id`: BMC, AARRR, build-measure-learn).

Spec Introspectionatomic (read-only)

Arguments

regionstringoptional

Exact-match UPGRegionId (e.g. "users_needs", "business_gtm_growth").

canonical_onlybooleanoptional

When true, return only the canonical playbook per region (W1 invariant restated).

framework_idstringoptional

Exact-match UPGFramework.id (e.g. "business-model-canvas", "pirate-metrics-aarrr").

Returns

Shape
{ count, playbooks: UPGPlaybook[] }

Examples

Live call against the Notion example graph.

Output

{
  "count": 23,
  "playbooks": [
    {
      "id": "playbook:strategy-outcomes",
      "name": "Strategy & Outcomes",
      "version": "0.2.0",
      "description": "Cascade vision through themes, outcomes, objectives, key results, and the bets you are making to get there.",
      "region": "strategy_outcomes",
      "is_canonical": true,
      "target_anchor_entity": "objective",
      "creation_sequence": [
        {
          "kind": "entity_sequence",
          "order": 1,
          "phase": "Vision & Mission",
          "name": "Vision & Mission",
          "prompt_hint": "Name what you are building toward and how you will get there. Vision is the destination; mission is the orientation. One of each, no more.",
          "entity_types": [
            "vision",
            "mission"
          ]
        },
        {
          "kind": "entity_sequence",
          "order": 2,
          "phase": "Themes",
          "name": "Themes",
          "prompt_hint": "Choose 2–4 strategic themes that focus the work. Past four, you have lost focus, not gained coverage.",
          "entity_types": [
            "strategic_theme",
            "strategic_pillar"
          ]
        },
        {
          "kind": "entity_sequence",
          "order": 3,
          "phase": "Outcomes",
          "name": "Outcomes",
          "prompt_hint": "Frame the changes in the world the product is trying
… (truncated)

See Also