Skip to main content
Glama

Instatus MCP by usefulapi

Create maintenance

instatus_create_maintenance
Destructive

CREATES a new scheduled maintenance — this MODIFIES live status-page data and can notify subscribers. Provide name (required); optionally set message, affected components, per-component impact via statuses, status, start/end, duration, and notify. Instatus: POST /v1/{page_id}/maintenances. Returns the created maintenance.

Input Schema

NameRequiredDescriptionDefault
endNoISO 8601 timestamp for when the maintenance ends.
nameYesMaintenance title (required).
startNoISO 8601 timestamp for when the maintenance starts.
notifyNoWhether to notify subscribers about this update.
statusNoMaintenance status.
messageNoMaintenance update message (Markdown supported).
page_idYesThe status page's id.
durationNoMaintenance duration in minutes.
statusesNoPer-component impact — set each listed component's status for this event.
componentsNoComponent ids affected by this maintenance.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations only supply destructiveHint=true, so the description usefully adds that this modifies live status-page data and can notify subscribers — an important side effect an agent should anticipate. It also maps the call to the underlying POST endpoint and states the return. It stops short of mentioning auth/permission requirements or whether a scheduled maintenance can be canceled after creation.

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 tight sentences: capability and side effect first, then parameters, endpoint, and return value. Every clause carries 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?

For a 10-parameter mutation tool with only destructiveHint covered by annotations and no output schema, the description supplies the effect on live data, notification behavior, and the return shape. It omits permissions and post-creation mutability, but what an agent needs to invoke it correctly is largely present.

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 every parameter is already documented, including the per-component 'statuses' impact mapping and enum values. The description enumerates the same fields (name required, message, components, statuses, status, start/end, duration, notify) without adding syntax, defaults, or interaction rules beyond the schema. Baseline 3 applies.

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?

States a specific verb+resource ('CREATES a new scheduled maintenance') and immediately characterizes the scope of the effect on live status-page data. The resource name itself separates it from instatus_create_incident, so an agent can select correctly without opening schemas.

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?

The description implies the usage context (scheduling maintenance that affects live status-page data and notifies subscribers), which is useful framing. But it never states when to prefer this over instatus_create_incident, instatus_update_maintenance, or what prerequisites (page_id ownership, permissions) must hold. Usage is inferable rather than explicit.

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.