Skip to main content
Glama

set_maintenance_window_checks

Replace the set of checks and check groups attached to a maintenance window, or clear them with empty arrays.

Instructions

Replace the set of checks (and/or check groups) attached to a maintenance window. Pass empty arrays to clear. To leave one of the two collections untouched, pass it with its current contents — partial updates are not supported by this endpoint.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidYesMaintenance window UID.
checkUidsNoArray of check UIDs to attach. Example: ["uid1","uid2"]. Empty array clears.
checkGroupUidsNoArray of check-group UIDs to attach. Example: ["groupUid1"]. Empty array clears.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.32.1

TDQS

A4.4/5.0
Behavior4/5

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

No annotations are present, so the description carries the behavioral burden. It discloses that this is a full replacement operation, that empty arrays clear collections, and that partial updates are not supported. It does not detail return values or permissions, but the central destructive/replacement behavior is clearly communicated.

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?

Two sentences with no filler. The core action is front-loaded, followed by the two most important behavioral caveats. Every clause earns its place.

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 mutation tool with no output schema and no annotations, the description is quite complete: it states what is replaced, how to clear, how to preserve one collection, and that partial updates are not supported. It could also mention what happens to previously attached checks or the response shape, but the provided guidance is sufficient to invoke the tool correctly in most cases.

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. The description adds meaning beyond the schema by explaining that leaving one collection untouched requires passing its current contents, and reiterating that partial updates are not supported. This helps an agent understand how checkUids and checkGroupUids interact, which the raw schema does not convey.

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?

The description opens with a specific verb and resource: 'Replace the set of checks (and/or check groups) attached to a maintenance window.' It clearly scopes the tool to maintenance-window check associations, distinguishing it from siblings like update_maintenance_window, get_maintenance_window, or delete_maintenance_window. The behavior is unambiguous and actionable.

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

Usage Guidelines4/5

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

It provides explicit operational guidance: how to clear via empty arrays, how to preserve a collection by passing its current contents, and a clear warning that partial updates are unsupported. It does not name alternative tools or explicitly say when to prefer this over update_maintenance_window, but the replacement semantics are clear enough for an agent to use it correctly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.