Skip to main content
Glama

BCD — Bridge Control Delegate

cancel_workflow

Destructive

Cancel a running workflow run by runId, in the same work session. No further step starts; a running command is stopped, while a running file step or copy finishes first. Completed steps are not rolled back. Poll workflow_status until the state is cancelled.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYes
deviceIdNoComputer name or id from list_devices. Optional with one computer online or a default set.
workSessionIdNoWork session from create_work_session. Pass the same ID on every call in this conversation; omit for legacy unscoped work.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior5/5

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

Annotations declare destructiveHint=true and readOnlyHint=false, and the description goes well beyond that: it specifies that no further step starts, that a running command is stopped while a running file step or copy completes first, and that completed steps are not rolled back. This granular cancellation semantics and irreversibility disclosure is exactly the extra context annotations cannot carry.

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 short sentences, front-loaded with the action and target, then the behavioral caveats, then the follow-up instruction. No filler and every sentence carries decision-relevant information.

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?

No output schema exists, so the description must cover outcomes — and it does via the 'poll workflow_status until cancelled' instruction, plus the per-step cancellation behavior. It omits edge cases such as what happens if the run has already finished or failed, which keeps it short of fully complete.

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 coverage is 67%: deviceId and workSessionId are already documented in the schema, while runId has no schema description. The description only says 'by runId' and 'in the same work session', which adds minimal meaning beyond what the schema properties already convey. Baseline 3 is appropriate when the schema does most of the work.

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?

Specific verb (cancel) plus resource (workflow run) plus identifier (runId) and session scoping ('in the same work session'). An agent can immediately separate this from siblings like delete_workflow (definition removal), run_workflow, or workflow_status.

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?

Gives clear context for use (a running workflow run) and names the follow-up action to take — 'Poll workflow_status until the state is cancelled' — which routes the agent to the correct next tool. It does not, however, state when not to use it (e.g. vs delete_workflow for a non-running workflow), so exclusions are left implicit.

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