Skip to main content
Glama

Maintenance window details

get_maintenance
Read-only

One maintenance window: title, description, start and end, phase, the monitors it covers, and whether it holds their paging. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe window id (from `list_maintenance`).

Output Schema

TableJSON 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.
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. Added

TDQS

B3.4/5.0
Behavior3/5

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

readOnlyHint=true already declares the safety profile, and "Read-only." merely restates it, earning no extra credit. The field-level detail about monitors covered and paging hold is genuinely useful behavioral context beyond the annotation, but the description says nothing about lookup failure behavior for a bad id.

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?

A single front-loaded sentence: the resource first, then the fields it carries, ending with a two-word read-only flag. Every clause conveys information and nothing is padded.

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?

An output schema exists, so return values elsewhere need not be explained, and the single required parameter is fully covered by the schema. The definition is adequate for a simple by-id read, though it omits error/missing-id behavior and any hint of when to prefer this over the list tool.

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 exists and schema description coverage is 100%, with the schema even documenting that the id originates from list_maintenance. The description adds no format, constraint, or sourcing detail beyond what the schema already provides, so the baseline of 3 applies.

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 names the exact resource returned ("One maintenance window") and enumerates its meaningful fields (title, description, start/end, phase, covered monitors, paging hold), so the agent instantly knows what comes back. It implies a single-item fetch versus list_maintenance, but never names that sibling explicitly, which keeps it out of the top band.

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

Usage Guidelines2/5

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

There is no statement of when to call this versus list_maintenance, update_maintenance, or cancel_maintenance. The only routing clue (the id comes from `list_maintenance`) lives in the input schema, not in the description, so the description itself offers no guidance.

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.