Skip to main content
Glama

abort_macro

Destructive

Stops a running QIDI macro without emergency stop shutdown or firmware restart, useful for stuck levelling, filament changes, or purges. Check status afterward; the sequence may be left mid-step.

Instructions

Abort a running macro (QIDI's breakmacro). Use it when a macro is stuck or is doing something you want stopped — a levelling routine, a filament change, a purge — without the emergency stop's shutdown and firmware restart. The macro stops wherever it is, so the printer may be left mid-sequence (parked oddly, heaters on, filament part-loaded): check get_printer_status afterwards. QIDI-specific: not available on stock Klipper.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "abort_macro"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.1

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only say destructiveHint=true and readOnlyHint=false; the description goes well beyond them by disclosing the exact consequences of an abort — printer left mid-sequence, parked oddly, heaters still on, filament part-loaded — and warns to verify state afterwards. It also adds an availability constraint (QIDI-specific, not on stock Klipper) that annotations cannot express.

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-loads the action, then the use case, then the side effects, then the platform caveat — each sentence adds distinct information with no repetition. Dense but not bloated for a destructive tool.

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?

An output schema exists, so return values need not be explained, and the description covers risk, recovery step, and platform availability. The only meaningful omission is any statement about the confirm flag, which is the one structured field left unexplained.

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

Parameters2/5

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

Schema description coverage is 0% and the single parameter (confirm, default false) is never mentioned in the description. For a destructive operation, the description should say whether confirm must be set or what happens when it is omitted; it leaves the agent to guess from the schema alone.

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 ("Abort a running macro") and immediately identifies the underlying QIDI command (breakmacro). It explicitly distinguishes itself from emergency_stop and, by implication, from cancel_print/pause_print, so an agent can pick it 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 Guidelines5/5

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

Gives concrete when-to-use conditions (macro stuck, levelling routine, filament change, purge) and names the alternative it is preferred over — the emergency stop with its shutdown and firmware restart. It also states a post-condition action (check get_printer_status), which is real operational guidance rather than filler.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools