Skip to main content
Glama

Run workflow

run_workflow
Destructive

Start a run. Spends credits, so the user must approve the cost first.

Needs estimate_run's run_token and the SAME script_text. Without confirm=true it starts nothing and returns the price to show the user; call again with confirm=true once they agree. Returns run_id and status; then poll get_run_status.

Input Schema

NameRequiredDescriptionDefault
confirmNofalse returns the price and starts nothing. true SPENDS credits — only after the user agrees.
run_tokenYesFrom estimate_run, bound to that workflow, graph and script_text. Expires in 10 minutes and is spent by the first run that starts.
script_textNoReplaces the workflow's stored script. estimate_run and run_workflow must get the SAME text.
workflow_idYesThe workflow_id from list_workflows. Never invent one.
dictionary_modeNoWhich dictionary entries this run applies. Omit to use the workflow's setting.
source_languageNoLocale of script_text, e.g. `ko-kr`. Must match the one given to estimate_run.
dictionary_entry_idsNoEntry ids from scan_script_for_dictionary_entries. Only with dictionary_mode='selected'.

Output Schema

NameRequiredDescriptionDefault
run_idNo
statusNo
createdNo
next_stepNo
max_creditsNo
workflow_nameNo
workspace_slugNo
current_balanceNo
run_console_urlNo
expected_creditsNo
workflow_summaryNo
requires_confirmationNo
estimated_overage_centsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / dictionary_entry_ids
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Entry ids from scan_script_for_dictionary_entries. Only with dictionary_mode='selected'.",
      +  "title": "Dictionary Entry Ids"
      +}
    • addedInput schema / properties / dictionary_mode
      Added value: +{
      +  "anyOf": [
      +    {
      +      "enum": [
      +        "all",
      +        "none",
      +        "selected"
      +      ],
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Which dictionary entries this run applies. Omit to use the workflow's setting.",
      +  "title": "Dictionary Mode"
      +}
  2. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and non-idempotent, but the description adds the crucial non-obvious behavior: this spends credits and must not be confirmed until the user approves the cost. That is real context beyond the annotation flags. It stops short of stating failure modes (e.g. what happens if the token expires or the script_text mismatches).

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?

Front-loaded with the purpose and the cost consequence, then the confirmation protocol, then the follow-up. Every sentence carries an actionable constraint; no filler or restatement of the title.

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 7-parameter, credit-spending, destructive operation with an output schema, the description covers the gates (token, confirm), the cost risk, and the next step. Return values need not be detailed since an output schema exists.

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; the description goes slightly further by tying run_token and script_text to estimate_run and stressing they must be the SAME text across both calls. Remaining parameters (dictionary_mode, source_language, dictionary_entry_ids) are left to the schema, which is adequate given full coverage.

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?

Opens with a specific verb+resource ("Start a run") and immediately distinguishes itself from estimate_run (price check) and get_run_status (polling), both named explicitly. An agent can route between these three 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?

States the prerequisite (estimate_run's run_token plus the identical script_text) and the full two-call sequence: without confirm=true nothing starts and only the price is returned; call again with confirm=true after the user agrees. It also names the follow-up tool (get_run_status) for polling.

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