Skip to main content
Glama

Change a maintenance window

update_maintenance_window
Idempotent

Changes a maintenance window or every occurrence of a repeating one. Fields left out keep their value; recurrence null makes it a single window. Changing the times or recurrence undoes skipped and moved occurrences. 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": {
      "window_id": "<window_id>"
    },
    "name": "update_maintenance_window"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoWhat the maintenance is, such as Database upgrade.
ends_atNoWhen 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_atNoWhen it starts, ISO 8601; the first occurrence of a repeating window.
window_idYesMaintenance window ID from list_maintenance_windows.
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.9/5.0
Behavior4/5

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

Goes well beyond the annotations by disclosing patch semantics, that recurrence null collapses the window to a single one, and that changing times or recurrence resets skipped and moved occurrences. Annotations already carry idempotent and non-destructive hints; the remaining gap is around permissions and confirmation behavior, not core mutation semantics.

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, each carrying distinct information, with the scope and patch behavior front-loaded before the side-effect warning. No filler or redundant restatement of the 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 9-parameter mutation with a nested recurrence object and no output schema, the description covers semantics, side effects, and the single-versus-repeating distinction. It stops short of noting permission or error conditions, but nothing essential for a correct call is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning beyond the schema: omitted fields preserve values and null recurrence converts the window to a single occurrence. That is synthesis the schema's per-field text does not state.

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?

States a specific verb and resource ('Changes a maintenance window') and extends scope to 'every occurrence of a repeating one', which implicitly contrasts with the per-occurrence sibling. It does not explicitly name change_maintenance_occurrence, so the differentiation is inferred rather than stated.

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?

Patch semantics ('Fields left out keep their value') and the recurrence-null rule tell the agent how to shape a call, but there is no explicit when-to-use guidance or routing to change_maintenance_occurrence for single-occurrence edits. Usage is implied rather than prescribed.

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