Skip to main content
Glama

Cancel a queued backup restore

cancelBackupRestore
Idempotent

Cancels a restore from restoreBackup that an online server has not applied yet. Pass the queued backupId. Fails if nothing is queued for it or it is already being applied.

Input Schema

NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and idempotentHint=true, so the safety profile is covered; the description adds real value by disclosing the two error conditions and the fact that only unapplied queued restores are affected. It stops short of saying what happens to the queued record or what the response contains.

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?

Three short sentences, front-loaded with the action and scope, followed by the required argument and the failure conditions. No filler and no repetition of the title.

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?

For a single-argument, non-destructive cancel with annotations covering safety and no output schema, the description supplies scope, required input, and error behavior. The only gap is the post-cancel state (whether the queue entry is removed and what is returned).

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 reported at 0% for the top-level 'path' parameter, but the nested backupId and serverId do carry descriptions pointing at listBackups and listServers. The description adds only the qualifier 'queued' for backupId and says nothing about serverId, so it neither compensates for the coverage gap nor adds much beyond the schema.

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 ('Cancels a restore from restoreBackup') and constrains it to restores an online server has not applied yet. It names the sibling tool that creates the queue entry, so an agent can distinguish cancel from restoreBackup without opening either 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?

Explicitly scopes usage to a queued-but-unapplied restore and states the failure conditions ('Fails if nothing is queued for it or it is already being applied'). It routes implicitly to restoreBackup as the counterpart but does not name an alternative for cancelling an in-progress restore, which is the one missing piece.

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