Skip to main content
Glama

hyperping

by com.hyperping
OverviewDiscussionsAdmin

Schedule maintenance

create_maintenance_window

Schedule a maintenance window: checks and alerts stop for its monitors during the window, and the status pages you pass announce it. Public once it has status pages: confirm with the user first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesInternal name, shown in the dashboard only.
titleNoPublic title on the status pages. Defaults to name.
notifyNoSubscriber notification: now, "scheduled" before the start, or "none" (default).
messageNoPublic description of the work, shown on the status pages and sent to subscribers.
end_dateYesEnd, after start_date, ISO 8601 with a timezone, e.g. "2026-10-04T02:00:00Z" or "2026-10-04T04:00:00+02:00".
languageNoTwo-letter code of the language the text is written in, e.g. "fr". Defaults to the status page's default language.
monitorsYesMonitors (mon_...), components (comp_...) or servers (agt_...) under maintenance: their checks and alerts stop during the window.
timezoneNoIANA timezone the window is scheduled in, e.g. "Europe/Paris". start_date and end_date without an offset are read in it. Subscriber messages are dated in it when the status page has no timezone. Defaults to the project's timezone, else UTC.
start_dateYesStart, ISO 8601 with a timezone, e.g. "2026-10-04T02:00:00Z" or "2026-10-04T04:00:00+02:00".
status_pagesNoUUIDs of the status pages that announce the window.
notify_minutes_beforeNoWith notify "scheduled": minutes before the start. Default 60.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / timezone
      Added value: +{
+  "description": "IANA timezone the window is scheduled in, e.g. \"Europe/Paris\". start_date and end_date without an offset are read in it. Subscriber messages are dated in it when the status page has no timezone. Defaults to the project's timezone, else UTC.",
+  "maxLength": 64,
+  "type": "string"
+}
  2. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations cover the safety profile (non-read-only, non-destructive, open-world, non-idempotent), and the description adds substantive behavior beyond them: monitors' checks and alerts stop during the window and attached status pages publicly announce it. The public-visibility warning and required user confirmation are genuinely useful behavioral context.

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, zero waste, with the action and its effects front-loaded before the public-visibility caveat. 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 an 11-parameter creation tool with full schema coverage and no output schema, the description supplies the essential purpose, side effects, and a publicity warning. It does not note things like notification timing behavior (notify/notify_minutes_before) beyond the schema, but the schema covers those adequately.

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 the schema already documents all 11 parameters with formats, defaults, and constraints. The description adds no parameter-level detail beyond reiterating that monitors stop checks and that status pages announce the window, so 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 (Schedule) and resource (maintenance window) and explains the effect on monitored systems. It is clearly distinguishable from cancel/complete/update_maintenance_window by the scheduling action, though it does not explicitly name a sibling to contrast against.

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?

Gives a clear usage condition and caution: the window becomes public once status pages are attached, so the agent should confirm with the user first. It does not describe when to prefer update_maintenance_window or how it relates to the cancel/complete siblings, leaving some routing to inference.

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

All hyperping toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources