Skip to main content
Glama

Change a maintenance window

update_maintenance
DestructiveIdempotent

Use this when the user wants to change planned or running maintenance: end it early or start it now, extend or move it, rename it, or pause or resume a recurring schedule. Changes it as the dashboard's Maintenance page does and returns the window as it is now. A window that asked to tell subscribers emails them as the page's would: the new time when a one-time window moves, and that it started or ended. Not for new work (use draft_maintenance), calling it off (use cancel_maintenance) or an outage (use draft_incident_post).

Input Schema

NameRequiredDescriptionDefault
siteYesThe window's site: its id, name or part of its URL.
whenNoFor edit: the new start, a date and time such as 2026-11-02 02:00 (read in timezone), or RFC 3339; for a recurring window, the time of day.
titleNoFor edit: the new title, as subscribers will read it.
actionYesedit changes the fields given and keeps the rest; start begins a scheduled window now; end finishes one in progress now; pause and resume a recurring schedule.
timezoneNoFor edit: the IANA time zone when is read in. Default: the window's own zone.
descriptionNoFor edit: new details shown with the window; an empty string clears them.
maintenanceYesThe window: its id from list_incidents with kind maintenance, or its title.
duration_minutesNoFor edit: the new length, 1 to 720 minutes; a window in progress ends this long after it started.
notify_subscribersNoFor edit: whether status page subscribers are emailed about the window. Only when the user asks.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is carried structurally; the description adds real context beyond that: it returns the window as it is now, it behaves as the dashboard's Maintenance page does, and it discloses the subscriber-email side effect and when that email fires. It stops short of saying what is lost or irreversible when a running window is ended early, which is the remaining gap given destructiveHint.

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-loaded with the trigger condition and three tight sentences with no filler. The subscriber-email sentence is dense and slightly convoluted, but each sentence carries distinct information (trigger, effects, exclusions).

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 9-parameter mutation with no output schema, the description covers the trigger, the side effects, and the return ('returns the window as it is now'). The one omission is any warning about irreversibility when ending or pausing a window, which matters given destructiveHint=true.

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 the enum values are documented in the schema itself, so the baseline of 3 applies. The description adds behavioral meaning around notify_subscribers (subscribers are emailed the new time when a one-time window moves, and that it started or ended) but does not clarify the site/maintenance/when/timezone semantics beyond what the schema already says.

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 ('change planned or running maintenance') and then enumerates the exact mutations covered: end early, start now, extend, move, rename, pause/resume. It also names the siblings it is not (draft_maintenance, cancel_maintenance, draft_incident_post), so an agent can route correctly without opening any 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?

Explicit when-to-use in the opening clause, and an explicit when-not sentence with three named alternatives for the adjacent intents (new work, calling it off, an outage). Nothing about tool selection is left to inference.

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