Skip to main content
Glama

Extend MCP

Cancel a workflow run

cancel_workflow_run
DestructiveIdempotent

Cancel a queued or in-flight workflow run (workflows group). Best-effort: a run already finishing may still complete. Follow any llmContext guidance included in results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYesThe run ID from run_workflow.
environmentYes"TEST" = the Test (development) environment, "PRODUCTION" = live. Must match a granted target from get_me (an API key pins one environment).
workspaceIdYesTarget workspace (ws_...). Must be a granted workspace — get_me lists the accepted values.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
statusYes

TDQS

A4.2/5.0
Behavior4/5

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

Annotations carry the safety profile (destructiveHint=true, readOnlyHint=false, idempotentHint=true), and the description adds genuinely new behavioral context: the best-effort race condition where an already-finishing run may still complete, plus the instruction to follow llmContext guidance in results. No contradiction with annotations — the best-effort note is consistent with idempotentHint=true.

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?

Two sentences with the action and scope front-loaded, the sibling disambiguator in a tight parenthetical, and the best-effort caveat immediately after. The llmContext instruction is short and non-redundant with the schema or annotations; no filler survives.

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?

The output schema covers return values, annotations cover the destructive/idempotent profile, and the schema covers all three parameters, so the description only needed to handle applicability and edge behavior — which it does via the queued/in-flight scope and best-effort disclosure. Minor gap: it doesn't discuss downstream effects of canceling (e.g., dependent runs or webhook notifications), but nothing critical is missing for this complexity.

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

Parameters3/5

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

Schema description coverage is 100%, so the baseline of 3 applies. All three parameters (runId, environment, workspaceId) are already documented with provenance ('The run ID from run_workflow') and validation rules ('Must match a granted target from get_me'), so the description need not add parameter detail.

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 ('Cancel') and a precise resource ('a queued or in-flight workflow run'). The parenthetical '(workflows group)' disambiguates it from sibling cancelers cancel_classify_run, cancel_extract_run, and cancel_split_run, and the cancel-vs-delete verb distinction separates it from delete_workflow_run 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 Guidelines4/5

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

The 'queued or in-flight' qualifier gives clear context for when this tool applies, and the best-effort caveat ('a run already finishing may still complete') marks the applicability boundary. However, it never explicitly names alternatives (e.g., delete_workflow_run for finished runs) or states when not to cancel, so some routing is left to inference.

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.

TDQS

A4/5.0
Disambiguation5/5

Each tool targets a distinct resource+action combination, and the descriptions actively disambiguate potential overlaps (e.g., extract_data vs parse_document, detect_form_fields vs edit_pdf, get_file vs get_file_upload). The consistent verb_noun prefix pattern makes the semantic boundary of every tool immediately recognizable.

Naming Consistency4/5

The dominant verb_noun pattern is highly consistent across all nine domains (list_*, get_*, create_*, update_*, delete_*, run_*, get_*_run, get_*_batch, publish_*_version). Minor deviations exist: deploy_workflow_version vs publish_*_version for the same freeze-a-draft concept, and get_form_detection_run doesn't mirror its detect_form_fields counterpart.

Tool Count2/5

86 tools is a very heavy agent-facing surface, well past the 25+ threshold. The count is inflated by the near-identical 13-tool lifecycle repeated across extract, classify, and split (each with list/get/create/update/publish/runs/batches/versions), and while each tool has a distinct purpose, the sheer volume makes selection harder.

Completeness4/5

Core lifecycles are thoroughly covered: create → update → publish → run (single and batch) → poll → cancel → delete-run → list runs/versions. Notable gaps include no delete tool for extractors, classifiers, splitters, workflows, or evaluation sets, and edit/form-detection runs have no list endpoint (documented workaround: keep run IDs). These are hygenic gaps that don't block primary workflows.

Resources