Skip to main content
Glama

Get Scheduled Maintenance State Timeline

get_scheduled_maintenance_state_timeline
Read-only

Get one Scheduled Maintenance State Timeline by ID.

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": {
      "id": "<id>"
    },
    "name": "get_scheduled_maintenance_state_timeline"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesID.
selectNoOmit for all but subscriberNotificationStatusMessage.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / id / description
      Previous value: -"ID (UUID) of the Scheduled Maintenance State Timeline."New value: +"ID."
    • changedInput schema / properties / select / description
      Previous value: -"Field names to return. Omit for all but these large fields: subscriberNotificationStatusMessage."New value: +"Omit for all but subscriberNotificationStatusMessage."
  2. Changed2 schema fields changed
    • changedInput schema / properties / id / description
      Previous value: -"The unique identifier (UUID) of the Scheduled Maintenance State Timeline to retrieve. Example: \"550e8400-e29b-41d4-a716-446655440000\""New value: +"ID (UUID) of the Scheduled Maintenance State Timeline."
    • changedInput schema / properties / select / description
      Previous value: -"Optional: field names to return for each Scheduled Maintenance State Timeline (e.g. [\"_id\", \"name\"]). Omit to get all readable fields. Large fields excluded by default (request explicitly if needed): subscriberNotificationStatusMessage."New value: +"Field names to return. Omit for all but these large fields: subscriberNotificationStatusMessage."
  3. First observed

TDQS

B3.1/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=false, so the safety profile is fully covered by structured data. The description adds no behavioral context beyond that — nothing about error behavior for a missing or invalid ID, permissions needed, or what a 'state timeline' record actually contains. It is essentially a restatement of the name with no added disclosure.

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?

A single short sentence, front-loaded with the verb and resource, with no filler or redundancy. It is appropriately sized for a trivial lookup tool, though brevity here reflects thin content rather than efficient information density.

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?

The tool is low-complexity: two flat parameters, full schema coverage, clear annotations, and no output schema that would need explaining. Given that, a one-line description is nearly sufficient; the only real gap is the absence of any hint that an ID must first be retrieved via list_scheduled_maintenance_state_timelines.

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 the required 'id' and the optional 'select' projection parameter are already documented in the schema, and the baseline is therefore 3. The description adds only 'by ID', confirming that id is the lookup key; it says nothing extra about how select affects the returned payload, so it neither compensates nor detracts.

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 states a specific verb (Get) and a specific resource (Scheduled Maintenance State Timeline) plus the singular scope ('one ... by ID'), which distinguishes it from the sibling list_scheduled_maintenance_state_timelines. It does not, however, say anything about what distinguishes it from get_scheduled_maintenance_event or get_scheduled_maintenance_state, so the differentiation is only partial.

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 explicit when-to-use guidance, no mention of the list/update/delete siblings as alternatives, and no prerequisites (e.g., needing an ID obtained from the list tool first). The only implied guidance is that this is a single-record fetch rather than a listing, which an agent could infer from the name alone.

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.