Skip to main content
Glama

Cancel workflow plan

cancel_workflow_plan
Destructive

Cancels a prepared or confirmed plan before business changes are applied.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
planIdYesPrepared or confirmed workflow plan ID.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsNo
planIdNo
statusNo
storeIdNo
summaryNo
planHashNo
policyIdNo
warningsNo
createdAtNo
expiresAtNo
simulatedNo
parametersNo
confirmedAtNo
nextActionsNo
planVersionNo
continuationNo
workflowTypeNo
executionModeNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false. The description adds useful stage context (only prepared or confirmed plans, and no business changes have been applied yet), but is silent on whether cancellation deletes the plan, whether it is idempotent, and what happens if the plan was already applied.

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?

A single front-loaded sentence with no filler; the verb and the state constraint appear immediately. Nothing is repeated or padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema and annotations exist, so return values and safety profile are covered. However, for a destructive single-action tool, the description omits post-cancellation state and behavior for plans past the confirm stage, which an agent would need before invoking it.

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?

Only one parameter with 100% schema description coverage, so the baseline is 3. The description merely echoes the schema's 'prepared or confirmed workflow plan ID' qualifier and adds no format, lookup, or sourcing guidance (e.g., where to obtain the planId).

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 (cancels) and resource (prepared or confirmed workflow plan) plus the stage constraint 'before business changes are applied', which implicitly separates it from the apply_* and confirm_workflow_plan siblings. It does not name those siblings explicitly, so differentiation is inferential rather than stated.

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 phrase 'before business changes are applied' hints at the appropriate moment to use it (prior to apply/confirm), but there is no explicit when-to-use statement, no exclusion for plans already applied, and no pointer to confirm_workflow_plan or apply_* as the alternative path.

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