Skip to main content
Glama

stop_flow

Stop a LIVE or PAUSED flow: no new runs start; runs waiting (at a wait or a callback) are ended; then the version returns to READY, editable with apply_operations. Nothing is deleted; start_flow makes it LIVE again.

Input Schema

NameRequiredDescriptionDefault
versionIdYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/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 largely succeeds: it discloses that in-flight waiting runs are terminated, that no data is deleted, and that the state transition is reversible via start_flow. It omits error conditions (e.g., calling on a READY version) and any permission requirements.

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?

One dense sentence whose clauses are ordered by importance: action and precondition first, side effects next, resulting state and reversibility last. No filler or redundant restatement of the 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 two-parameter mutation with no annotations or output schema, the behavioral picture is unusually complete — state transition, side effects, and reversibility are all stated. The one meaningful gap is the undocumented workspaceId/versionId semantics.

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?

Schema description coverage is 0% and the description says nothing about either parameter. "The version returns to READY" hints that versionId identifies the flow version, but workspaceId's scoping role is never explained, leaving both required IDs undocumented.

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 ("Stop a LIVE or PAUSED flow") and immediately defines the operational outcome: no new runs, waiting runs ended, version back to READY. An agent can distinguish this from start_flow and pause_flow from the text alone.

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?

Gives clear applicable state (LIVE or PAUSED) and a follow-up path ("editable with apply_operations", "start_flow makes it LIVE again"). It stops short of explicitly contrasting with pause_flow, the closest sibling, so an agent must infer when pausing is preferable to stopping.

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