Skip to main content
Glama

Edit Maintenance Update

edit_status_maintenance_update
Idempotent

Correct a historical maintenance timeline message only. State and visibility remain immutable; this does not send subscriber notifications.

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": {
      "message": "<message>",
      "projectId": "<projectId>",
      "maintenanceId": "<maintenanceId>",
      "updateId": "<updateId>"
    },
    "name": "edit_status_maintenance_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
messageYes
updateIdYes
projectIdYesProject ID. Use list_projects to find available project IDs.
maintenanceIdYesMaintenance ID from list_status_maintenance

Output Schema

NameRequiredDescriptionDefault
updateYes
dashboardUrlNoFull dashboard URL of the affected resource
notificationFailedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare the mutation profile (readOnly=false, destructive=false, idempotent=true), so the description earns credit for extra context: only the message text is touched, state and visibility are untouched, and no subscriber notifications fire. It does not discuss permissions or validation failures, and return shape is covered by the output schema.

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 short sentences, zero filler, and the core scope constraint is front-loaded before the negative conditions. Nothing is restated from the title or 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 non-destructive mutation with an output schema and full annotation coverage, the description covers scope, side effects, and what is explicitly left unchanged. Missing only peripheral details such as required permissions or error behavior.

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 coverage is 50% – projectId and maintenanceId carry inline descriptions while message and updateId do not. The description's 'message only' phrasing clarifies that message is the sole editable field, but adds no length/format/validation detail to compensate for the undocumented updateId.

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?

It states a specific verb and scoped resource: correct the message of a historical maintenance timeline update. The clause 'State and visibility remain immutable' implicitly separates it from update_status_maintenance, but it does not name that sibling explicitly, so an agent must infer the routing.

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?

'Correct a historical...message only' plus the immutability clause tells the agent when this is appropriate versus a general maintenance update, and 'does not send subscriber notifications' pre-empts a misuse case. It stops short of naming the alternative tool for state changes or for adding new timeline entries.

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