Skip to main content
Glama

Cancel a maintenance window

cancel_maintenance
DestructiveIdempotent

Use this when the user calls off planned work: a scheduled or running maintenance window, or a recurring schedule as a whole. Cancels it as the dashboard's Maintenance page does; the subscribers who were told about it are emailed that it will not happen. Returns the cancelled window. A window already cancelled is left as it is. Not for an incident: use draft_incident_post with kind resolve.

Input Schema

NameRequiredDescriptionDefault
siteYesThe window's site: its id, name or part of its URL.
maintenanceYesThe window: its id from list_incidents with kind maintenance, or its title.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Goes beyond the annotations by disclosing the real-world side effect (subscribers are emailed), the return value ('Returns the cancelled window'), and no-op behavior on already-cancelled windows, which corroborates idempotentHint=true. With destructiveHint already declared, only the exact reversibility of a cancellation is left unstated.

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 trigger condition, then side effects, then the boundary case. Every sentence carries information an agent cannot get from annotations or schema.

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, but the description says what is returned, and it covers idempotency, notification side effects, and the incident exclusion. The only mild gap is how cancelling an entire recurring schedule differs operationally from cancelling one instance.

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% and both parameters are documented there ('id, name or part of its URL' and 'id from list_incidents with kind maintenance, or its title'). The description's phrase about a 'recurring schedule as a whole' hints at what the maintenance identifier can target but adds no syntax detail beyond the schema, so baseline 3 applies.

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 resource (maintenance window), and explicitly scopes it to scheduled, running, or recurring schedules. It reads distinctly from siblings like update_maintenance, draft_maintenance, and schedule_maintenance.

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?

Opening clause names the trigger ('when the user calls off planned work') and the closing sentence names the alternative for the adjacent case ('Not for an incident: use draft_incident_post with kind resolve'). When-to-use and when-not-to-use are both explicit.

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