Skip to main content
Glama

Schedule maintenance

create_maintenance_window

Schedules maintenance for one monitor or all: no incidents or alerts while it lasts (suppress_alerts), and with announce the status pages that show it list it and tell their subscribers. With recurrence it repeats daily, weekly on chosen days or monthly, in the workspace's time zone (get_account), starting with starts_at to ends_at. Every plan. Free.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>",
      "starts_at": "<starts_at>",
      "ends_at": "<ends_at>"
    },
    "name": "create_maintenance_window"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesWhat the maintenance is, such as Database upgrade.
ends_atYesWhen it ends, after starts_at.
messageNoWhat visitors are told about the maintenance.
announceNoShow the window on the status pages that show its monitor (every page of the workspace without a monitor), and tell their subscribers, one occurrence at a time.
starts_atYesWhen it starts, ISO 8601; the first occurrence of a repeating window.
monitor_idNoThe monitor under maintenance; leave out or null for every monitor.
recurrenceNoHow the window repeats; `null` or left out for a single window. starts_at and ends_at are then the first occurrence, and every other one starts at the same time of day in time_zone, daylight saving time or not, and lasts as long.
suppress_alertsNofalse keeps the window on record without holding alerts back.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare this is a non-read-only, open-world, non-idempotent, non-destructive write. The description goes beyond that by explaining the operational effect: no incidents or alerts while the window lasts, announce causes status pages and subscribers to be notified per occurrence, and recurrence follows the workspace time zone (with a pointer to get_account). It does not cover return values or what happens when a duplicate window already exists.

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

Conciseness3/5

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

The purpose is front-loaded and the total length is reasonable for an 8-parameter tool. However, the second clause ("and with announce the status pages that show it list it and tell their subscribers") is grammatically tangled and slows comprehension of a key option, which costs it points on structure.

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

Completeness3/5

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

For a creation tool with a nested recurrence object and no output schema, the description covers recurrence behavior, alert suppression, announcement effects, and time-zone defaulting adequately. It omits what the call returns (e.g., the new window's identifier) and any prerequisite or conflict behavior, leaving the agent partially informed after a successful call.

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 100%, so the schema already documents every parameter including the full recurrence object; the baseline of 3 applies. The description reinforces the important cross-parameter semantics (starts_at/ends_at are the first occurrence when recurring, suppress_alerts holds alerts back, announce is per occurrence), but it mostly restates what the schema already supplies rather than adding new meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: it schedules maintenance for either one monitor or all monitors. Scope is clear from the first clause, but it never distinguishes itself from update_maintenance_window or list_maintenance_windows, so an agent must rely on the name alone for sibling separation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It implies when to use the tool (to suppress incidents and alerts, and optionally announce on status pages) and notes availability ("Every plan. Free."), which is useful context. It provides no explicit when-not guidance and never points to update/delete/change_maintenance_occurrence for subsequent adjustments, so usage selection is only implied.

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