Skip to main content
Glama

Run Workflow

workflow_run
DestructiveIdempotent

Queue a run of one exact saved Workflow version. mode pilot is an isolated trial; mode run is production. max_charge_credits is a hard ceiling for the whole run. idempotency_key is required: resubmitting with the same key replays the existing run (replay:true) instead of starting another. Returns the run summary and poll_after_ms; follow progress, results, cancel, or resume with workflow_runs.

Input Schema

NameRequiredDescriptionDefault
modeYespilot for an isolated trial run, run for production.
inputNoInline Workflow input; mutually exclusive with input_artifact_id.
actionNoOptional symmetry alias. Omit it or pass submit.
versionYesExact immutable saved version; latest is not accepted.
max_rowsNoMaximum result rows: max 10000.
workflow_idYesWorkflow ID that owns the saved version.
idempotency_keyYesStable exactly-once retry key for submit.
input_artifact_idNoTenant-owned artifact holding the Workflow input.
max_charge_creditsYesPositive decimal hard cap for the complete run.

Output Schema

NameRequiredDescriptionDefault
runNoRun summary.
replayNoTrue when an identical submit was replayed.
poll_after_msNoSuggested poll delay for queued runs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare idempotentHint and destructiveHint, so the bar is lower, and the description usefully goes beyond them: it explains that a repeated idempotency_key replays the existing run (replay:true) rather than starting another, and that max_charge_credits is a hard ceiling for the whole run. It does not cover auth/permission requirements or what state changes occur, keeping it short of a 5.

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?

Four dense sentences, each earning its place: purpose first, then mode semantics, then the credit cap, then idempotency and follow-up routing. No filler or redundancy.

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?

For a 9-parameter mutation tool with an output schema, the description supplies the operational context an agent needs: mode choice, cost ceiling, exactly-once retry behavior, and where to go next for run lifecycle operations. Return-value explanation is unnecessary given the output schema, and nothing material is missing.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning beyond the schema: it defines pilot vs run semantics, frames max_charge_credits as a hard run-wide ceiling, and clarifies the replay behavior of idempotency_key. It adds value on the semantically tricky parameters rather than merely restating them.

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 ('Queue a run of one exact saved Workflow version'), and the emphasis on 'exact saved version' distinguishes it from siblings like workflow_validate or workflow_definition. An agent can identify the operation without opening the schema.

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?

Explicitly explains the pilot-vs-run selection condition and routes follow-up work (progress, results, cancel, resume) to workflow_runs, which is a clear alternative. It stops short of an explicit when-not to use it (e.g., validating a definition first), so it is strong but not fully 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.