Skip to main content
Glama

Get maintenance window

nodeping_get_maintenance
Read-only

One maintenance entry by id. GET /maintenance/{id}.

Input Schema

NameRequiredDescriptionDefault
customer_idNoSubAccount customer id (MSP accounts). Omit for your own account.
maintenance_idYesMaintenance id, e.g. NZT101.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is fully covered structurally. The description's only additional content is the raw REST endpoint mapping (GET /maintenance/{id}), which adds no behavioral insight such as auth requirements, error behavior for a missing id, or response shape.

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

Conciseness4/5

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

Two terse sentences with the core purpose front-loaded and zero filler. The endpoint fragment is arguably redundant with the schema, but it costs almost nothing.

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 simple single-resource read with full annotation and schema coverage, the definition is minimally adequate. However, with no output schema, the agent gets no hint about what a maintenance entry contains, and the MSP/customer_id scoping caveat is never surfaced in the description.

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%, so both maintenance_id (with its NZT101 example) and customer_id (MSP subaccount scoping, 'Omit for your own account') are already documented in the schema. The description's 'by id' adds nothing beyond that, so the baseline 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?

States a specific verb+resource: retrieve one maintenance entry by id. The phrase 'One maintenance entry' implicitly distinguishes it from nodeping_list_maintenance, which returns many. It stops short of naming that sibling explicitly, so it lands just under full marks.

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?

Usage is only implied: the agent can infer 'use this when you already have a maintenance id' versus the list tool for discovery, but no condition or alternative is stated. There is also no mention of when the subaccount customer_id parameter applies.

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.