Skip to main content
Glama

Run a Workbench flow

workbench_flows_run

Execute a flow and return its outputs synchronously. Runs the draft by default; pass source:"published" (optionally a version) to run the live published version. Spends workspace LLM budget, bounded by the token's cost cap. input is the flow's input envelope, e.g. {"kind":"chat","messages":[…]} or {"kind":"form","values":{…}}.

Input Schema

NameRequiredDescriptionDefault
inputNoFlow input envelope (RunFlowInput). Omit for a flow that needs none.
flowIdYesFlow id to run.
sourceNoWhich version to run. Default: draft.
versionNoPublished version label (only with source:"published").
timeoutMsNoMax runtime in ms (also the hard cost ceiling).
workspaceNoWorkspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys.
approvalIdNoRe-call with the approvalId from a needs_confirmation response after the user approves.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false and openWorldHint=true but say nothing about cost; the description adds that it spends workspace LLM budget bounded by the token's cost cap and runs synchronously. That is genuine context beyond the structured fields, though side effects, idempotency, and the needs_confirmation/approval path are not surfaced here.

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?

Three sentences, front-loaded with the core action before the source-selection and input-format details; every sentence carries information. Slightly dense in the final clause but no wasted text.

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 7-parameter mutation with no output schema, it covers execution mode, source selection, cost implications, and input format. The main gap is that return values are only described as 'its outputs synchronously', leaving the response shape underspecified without an output schema to compensate.

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

Parameters4/5

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

With 100% schema description coverage the baseline is 3, but the description adds concrete meaning by giving example input envelope shapes ({"kind":"chat","messages":[…]} / {"kind":"form","values":{…}}) and clarifying the draft-vs-published default for source/version. This goes beyond restating the schema.

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

Purpose4/5

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

States a specific verb and resource ('Execute a flow and return its outputs synchronously'), which clearly separates it from read-style siblings like workbench_flows_get or workbench_flows_list. It does not explicitly name an alternative tool, so it falls short of the 5-level sibling differentiation, but the action is unambiguous.

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

Usage Guidelines3/5

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

The description explains that draft runs by default and that source:"published" (with optional version) runs the live version, which is useful conditional guidance. However, it never states when to prefer this over adjacent tools such as workbench_flows_schedules_run_now or caliper_evals_run, leaving usage primarily implied.

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