MCP Tools
Plans & Playbooks

get_cycle_generation

Read the latest "Generate all" batch of a playbook cycle: overall status and each step's progress.

Parameters

NameTypeRequiredDefaultDescription
team_idintegerYes—Team id to act in (from initialize instructions or get_current_user_info). Required on external MCP; optional in bound sessions.
run_idintegerYes—Cycle id — the run_id from list_playbook_cycles.

Input Schema

{
  "type": "object",
  "required": [
    "team_id",
    "run_id"
  ],
  "properties": {
    "run_id": {
      "type": "integer",
      "description": "Cycle id — the integer run_id from list_playbook_cycles / instantiate_playbook, not a UUID."
    },
    "team_id": {
      "type": "integer",
      "minimum": 1,
      "description": "Team id to act in (from initialize instructions or get_current_user_info). Required on external MCP; optional in bound sessions."
    }
  }
}

Output Schema

{
  "type": "object",
  "properties": {
    "batch": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "reason": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Machine reason for skipped / blocked / failed / not_started pieces."
              },
              "status": {
                "enum": [
                  "queued",
                  "generating",
                  "done",
                  "failed",
                  "blocked",
                  "skipped",
                  "not_started"
                ],
                "type": "string"
              },
              "message": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "position": {
                "type": "integer",
                "description": "1-based step position in the cycle."
              },
              "plan_uuid": {
                "type": "string"
              },
              "depends_on": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "plan_uuids of earlier steps this piece builds on."
              },
              "generation_id": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Pass to get_generation_status for that piece."
              }
            }
          }
        },
        "run_id": {
          "type": "integer"
        },
        "status": {
          "enum": [
            "running",
            "completed",
            "stopped",
            "interrupted"
          ],
          "type": "string"
        },
        "message": {
          "type": [
            "string",
            "null"
          ]
        },
        "created_at": {
          "type": "integer"
        },
        "updated_at": {
          "type": "integer"
        },
        "stop_reason": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "cycle_link_url": {
      "type": "string"
    }
  }
}

Instructions

Read the latest Generate all batch of a playbook cycle: the overall status (running, completed, stopped or interrupted) and each step's status (queued, generating, done, failed, blocked, skipped or not_started), with a reason and message where relevant. Returns batch: null when none was ever started. Read-only.

When to use: to follow up after generate_cycle_content, or when the user asks how a cycle's generation is going.

Parameters:

Parameter Type Required Description
team_id integer Yes* Team ID to act in (required on external MCP; optional in bound sessions)
run_id integer Yes Cycle id: the run_id from list_playbook_cycles

Output: batch, in the same shape as the batch returned by generate_cycle_content: id, run_id, status, stop_reason, message, items (one per step, each with position, plan_uuid, title, status, reason, message, generation_id and depends_on), created_at and updated_at. Pass a step's generation_id to get_generation_status for that single step.

Example prompts:

  • "How is the generation going on my launch cycle?"
  • "Which steps are done and which failed?"

Links: present link_url to the user exactly as returned — copy it character for character. Never retype, shorten, or rebuild a link or the IDs inside it.