Skip to main content
Glama

Draft a maintenance window

draft_maintenance

Use this when the user plans work on a site (a deploy, an upgrade, a migration) and wants it marked as maintenance, once or on a schedule, optionally telling status page subscribers. Returns the window in the user's time zone (and the next occurrences of a recurring one), the status pages it shows on and how many subscribers would be emailed, with a draft id. Saves the draft and schedules nothing. Not for an outage that is already happening: use draft_incident_post.

Input Schema

NameRequiredDescriptionDefault
daysNoFor weekly or biweekly: the weekdays, such as saturday. Default: the weekday of when's date.
siteYesThe site: its id, name or part of its URL.
whenYesWhen it starts: 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 such as 02:00.
titleYesWhat the work is, as subscribers will read it.
weekdayNoFor monthly on a weekday: the day.
timezoneNoThe IANA time zone the time is in, such as Europe/London. Default: the user's own zone.
recurrenceNonone (once, the default), daily, weekly, biweekly or monthly.
descriptionNoOptional details shown with the window.
day_of_monthNoFor monthly on a date: the day, 1 to 31.
week_of_monthNoFor monthly on a weekday: which one.
duration_minutesYesHow long it lasts, 1 to 720 minutes (12 hours).
notify_subscribersNoEmail the status page subscribers about it. Only when the user asks; default false.

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?

Annotations declare non-read-only, non-destructive, non-idempotent behavior; the description adds important context beyond them: a draft is saved, nothing is scheduled, and the return includes the window in the user's time zone, next recurrence occurrences, affected status pages, subscriber email count, and a draft id. It does not cover draft persistence, visibility, or notification timing, but it is substantially more informative than the annotations alone.

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 sentences, front-loaded with the trigger and exclusion, followed by return and draft behavior. Every sentence adds selection or behavioral value, with no restatement of the title 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?

For a 12-parameter tool with no output schema and complex recurrence options, the description covers the trigger, draft-only semantics, and key return fields. It leaves out some possible details such as draft expiry, where the draft is stored, or whether subscriber notification is sent now or only counted, so it is strong but not fully complete.

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%, with every parameter documented inline, including enums and defaults. The description's phrases like 'once or on a schedule' and 'next occurrences of a recurring one' provide framing but no syntax or format detail beyond what the schema already gives, so baseline 3 is appropriate.

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 (draft a maintenance window) plus the exact scope: planned work on a site, once or on a schedule, optionally notifying subscribers. It also distinguishes itself from draft_incident_post for outages already in progress, so an agent can tell sibling tools apart.

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?

Explicitly names the triggering situation (user plans a deploy, upgrade, or migration and wants it marked as maintenance) and the exclusion (not for an outage already happening; use draft_incident_post instead). The note that it 'saves the draft and schedules nothing' also implicitly routes scheduling use cases to schedule_maintenance.

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