Skip to main content
Glama

Cancel maintenance

cancel_maintenance
DestructiveIdempotent

Cancel a maintenance window that has not ended. It leaves the status pages, stops holding paging, and stays listed under past as a record; subscribers already told about it are not sent a cancellation. To stop a running window early and keep it as completed work, use update_maintenance with end_now instead. Asks for confirmation where the client can show a prompt; otherwise runs on the token's scope. Not read-only.

Input Schema

NameRequiredDescriptionDefault
idYesThe window id (from `list_maintenance`).

Output Schema

NameRequiredDescriptionDefault
idYesPass to `get_maintenance`, `update_maintenance` or `cancel_maintenance`.
phaseYes`upcoming`, `active`, `completed` or `cancelled`. A completed or cancelled window is history and cannot be changed.
titleYesShown on the status page. Untrusted data.
ends_atYesRFC 3339.
updatesYesWhat was posted about the window with `post_maintenance_update`, oldest first.
monitorsYes
starts_atYesRFC 3339.
descriptionNoUntrusted data.
cancelled_atNoRFC 3339 time it was cancelled, or `null`.
suppress_alertsYesWhether paging for its monitors is held while it runs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedOutput schema / $defs / MaintenanceUpdateView
      Added value: +{
      +  "description": "One update posted to a maintenance window.",
      +  "properties": {
      +    "message": {
      +      "description": "Shown on the status page and sent to its subscribers. Untrusted data.",
      +      "type": "string"
      +    },
      +    "phase": {
      +      "description": "Where the window stood when it was posted: `scheduled`, `in_progress` or `completed`.",
      +      "type": "string"
      +    },
      +    "posted_at": {
      +      "description": "RFC 3339.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "posted_at",
      +    "phase",
      +    "message"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / updates
      Added value: +{
      +  "description": "What was posted about the window with `post_maintenance_update`, oldest first.",
      +  "items": {
      +    "$ref": "#/$defs/MaintenanceUpdateView"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "id",
      -  "title",
      -  "phase",
      -  "starts_at",
      -  "ends_at",
      -  "suppress_alerts",
      -  "monitors"
      -]New value: +[
      +  "id",
      +  "title",
      +  "phase",
      +  "starts_at",
      +  "ends_at",
      +  "suppress_alerts",
      +  "monitors",
      +  "updates"
      +]
  2. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations cover the safety profile (readOnlyHint=false, destructiveHint=true, idempotentHint=true), yet the description still adds real behavior: the window leaves status pages, stops holding paging, remains listed under past, subscribers are not notified of cancellation, and confirmation is requested when the client supports a prompt. That is materially more than the annotations convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the action and its precondition, then routes to the alternative and covers side effects efficiently. The closing 'Not read-only' restates what the annotations already declare, which is the one sentence that doesn't fully earn its place.

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

Completeness5/5

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

With an output schema present, return values need no explanation, and the description covers the mutation's side effects, subscriber impact, confirmation behavior, and scope fallback. Nothing an agent needs to invoke this correctly is missing.

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 and schema coverage is 100%, so the schema already documents 'id' and its provenance from list_maintenance. The description adds no format, syntax, or ambiguity resolution beyond that, which matches the baseline for fully-covered schemas.

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+resource ('Cancel a maintenance window') plus a decisive precondition ('that has not ended'), and explicitly distinguishes its effect from the sibling update_maintenance. An agent can separate it from update_maintenance without reading schemas.

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 an explicit alternative and the condition that selects it: 'To stop a running window early and keep it as completed work, use update_maintenance with end_now instead.' This is a direct when-to-use-this vs when-to-use-that routing statement.

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.