Skip to main content
Glama

Get Workflow Session

get_workflow_session
Read-onlyIdempotent

Poll a previously started workflow run for its current step-by-step status and output (useful when run_workflow timed out or is awaiting a checkpoint). Also returns that run's definition_sha — the fingerprint of the definition it resolved when it started, comparable against the one plan_workflow reported. Requires authentication.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
session_idYesThe workflow session ID returned by run_workflow.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYes
executionYesThe execution plan frozen at run creation, or null when the run recorded none. Never recomputed from the current template.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "execution": {
      +      "additionalProperties": false,
      +      "description": "The execution plan frozen at run creation, or null when the run recorded none. Never recomputed from the current template.",
      +      "properties": {
      +        "degradation_reason": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "degraded_to_list_order": {
      +          "type": "boolean"
      +        },
      +        "dependency_graph": {
      +          "additionalProperties": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "type": "object"
      +        },
      +        "layers": {
      +          "items": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "type": "array"
      +        },
      +        "order": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "parallelism_used": {
      +          "type": "boolean"
      +        }
      +      },
      +      "required": [
      +        "order",
      +        "layers",
      +        "dependency_graph",
      +        "degraded_to_list_order",
      +        "degradation_reason",
      +        "parallelism_used"
      +      ],
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    },
      +    "text": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "text",
      +    "execution"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "text": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "text"
      -  ],
      -  "type": "object"
      -}New value: +null
  3. First observed

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already establish the safe read-only/idempotent profile, so the bar is lower, yet the description adds meaningful context: this is a polling call, returns step-by-step progress, surfaces the run's definition_sha fingerprint, and requires authentication. That is substantive behavioral detail beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with the primary purpose and the key usage condition front-loaded, followed by the extra return signal. Every clause (definition_sha, auth requirement) carries actionable information with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Because an output schema exists, the description is not obligated to enumerate return values, and it already flags the notable definition_sha field. For a single-parameter polling tool this is nearly complete; only explicit alternative-tool routing is absent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single session_id parameter is fully documented in the schema as the ID returned by run_workflow. The description adds no further syntax or format detail for the parameter, so the schema does the heavy lifting and baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb ('poll'), the exact resource ('a previously started workflow run'), and the payload ('step-by-step status and output'). It also distinguishes itself from run_workflow and plan_workflow by referencing them, so an agent can separate it from the many workflow siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a concrete when-to-use signal: 'useful when run_workflow timed out or is awaiting a checkpoint.' That condition clearly routes the agent to polling over re-running. It stops short of naming the sibling alternatives (e.g. advance_workflow, retry_workflow) as explicit substitutes, so it's clear but not exhaustive.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources