Skip to main content
Glama

pause_flow

Pause a LIVE flow: its triggers and schedule stop starting runs; nothing is deleted. Running runs continue, but a run waiting at a mid-flow callback cannot be resumed while paused. A PAUSED flow is not editable — to edit, use stop_flow. start_flow resumes it.

Input Schema

NameRequiredDescriptionDefault
versionIdYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does substantial work: nothing is deleted, in-flight runs continue, and a run parked at a mid-flow callback cannot be resumed while paused — a non-obvious side effect. It stops short of stating idempotency (what happens if the flow is already paused), any permission requirements, or the return value.

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?

Three short sentences, each front-loading the most decision-relevant fact (scope, side effects, cross-tool alternatives). No filler or restatement of the tool name.

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?

For a lifecycle-mutating tool with no annotations and no output schema, the description covers state semantics, irreversible-vs-reversible behavior, and sibling routing well. The remaining gap is parameter meaning, which matters because two required IDs are entirely undocumented.

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

Parameters2/5

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

Both parameters (versionId, workspaceId) have 0% schema description coverage and the description never mentions them, so an agent gets no signal about which identifier selects the flow to pause or whether versionId refers to a live version. With two undocumented required params, the description should have compensated and does not.

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?

Names a specific verb (pause) and resource (a LIVE flow) and immediately scopes what pausing means: triggers and schedule stop starting runs. It also distinguishes itself from stop_flow and start_flow by name, so an agent can route correctly without opening any schema.

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 states the alternative for the adjacent need ('A PAUSED flow is not editable — to edit, use stop_flow') and the inverse operation ('start_flow resumes it'). This is genuine when/when-not routing rather than implied usage.

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