Skip to main content
Glama

get_flow_context

Read-only

Return one flow's graph topology: its blocks in reading order from the start block, a short summary per block, and where each block and each menu button leads (links[].to, menu.buttons[].to). Read-only. Deliberately omits block data, action configs and the ids of buttons, actions, links and condition rules to stay cheap, and returns message text and condition operands only as cut *Preview fields (textPreview, firstOperandPreview, valuePreview) that are for reading, never for writing back — once you know which block matters, call get_block_details for its full contents. This is the normal first step before editing an existing flow.

Input Schema

NameRequiredDescriptionDefault
flowIdYesRequired. Flow id, as returned by get_workspace_summary or get_application_context.
applicationIdNoApplication (workspace) id. Optional: an application-scoped key (app_...) defaults to its own application, but a personal key (usr_...) has no default and omitting it fails with MCP_APPLICATION_REQUIRED. Call list_applications to get the id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / applicationId / description
      Added value: +"Application (workspace) id. Optional: an application-scoped key (app_...) defaults to its own application, but a personal key (usr_...) has no default and omitting it fails with MCP_APPLICATION_REQUIRED. Call list_applications to get the id."
    • addedInput schema / properties / flowId / description
      Added value: +"Required. Flow id, as returned by get_workspace_summary or get_application_context."
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation it discloses the deliberate cost/coverage trade-off, lists precisely what is omitted (block data, action configs, button/action/link/rule ids), and warns that *Preview fields are for reading and never for writing back. That is behavioral context an agent could not derive from annotations or schema.

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

Conciseness4/5

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

Front-loads the return shape before the caveats and every sentence carries information. It is dense with parenthetical field lists, slightly long, but no sentence is filler.

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

Completeness5/5

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

No output schema exists, and the description fully compensates by describing the returned structure (including links[].to and menu.buttons[].to) and its truncation behavior. An agent knows what it gets, what it does not get, and where to go next.

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 schema already explains flowId provenance and the applicationId personal-key failure mode in detail. The description adds nothing about either parameter, so the 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?

States a specific verb and resource ('Return one flow's graph topology') and enumerates exactly what comes back: blocks in reading order, per-block summaries, and link/menu targets. It is clearly distinguished from get_block_details, which the description names as the deeper follow-up.

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

Usage Guidelines5/5

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

Explicitly positions itself as 'the normal first step before editing an existing flow' and names the alternative ('once you know which block matters, call get_block_details'). Both the when-to-use and the hand-off are stated, leaving nothing to inference.

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.