Phare

Get a maintenance window

get_maintenance_window

Read-onlyIdempotent

Get a maintenance window by ID, with its state, schedule, monitoring mode, monitors and status pages.

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": {
      "project_id": "<project_id>",
      "maintenance_window_id": "<maintenance_window_id>"
    },
    "name": "get_maintenance_window"
  }
}

Input Schema

Name	Required	Description	Default
`project_id`	Yes	ID of the project to act on, see whoami
`maintenance_window_id`	Yes	ID of the maintenance window to show

Output Schema

Name	Required	Description
`id`	No	Maintenance window ID
`tags`	No	Resource tags, made of lowercase letters, numbers, `.`, `_`, `:` and `-`. An organization can have up to 200 tags.
`state`	No	Maintenance window state
`title`	No	Maintenance window title
`ends_at`	No	Date and time when the maintenance window ends, with minute precision (seconds must be `00`). Must be after `starts_at` and within the next year.
`monitors`	No	List of monitor IDs linked to the maintenance window
`starts_at`	No	Date and time when the maintenance window starts, with minute precision (seconds must be `00`). Must be within the next year.
`created_at`	No	Date of creation for the entity
`project_id`	No	Parent project ID
`updated_at`	No	Date of last update for the entity
`description`	No	Description of the maintenance window
`status_pages`	No	List of status page IDs linked to the maintenance window
`monitoring_mode`	No	Monitoring mode during maintenance

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedNov 7, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "created_at": {
+      "description": "Date of creation for the entity",
+      "format": "date-time",
+      "type": "string"
+    },
+    "description": {
+      "description": "Description of the maintenance window",
+      "examples": [
+        "Planned database upgrade and maintenance"
+      ],
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "ends_at": {
+      "description": "Date and time when the maintenance window ends, with minute precision (seconds must be `00`). Must be after `starts_at` and within the next year.",
+      "format": "date-time",
+      "type": "string"
+    },
+    "id": {
+      "description": "Maintenance window ID",
+      "examples": [
+        1
+      ],
+      "type": "integer"
+    },
+    "monitoring_mode": {
+      "description": "Monitoring mode during maintenance",
+      "enum": [
+        "pause",
+        "mute",
+        "normal"
+      ],
+      "type": "string"
+    },
+    "monitors": {
+      "description": "List of monitor IDs linked to the maintenance window",
+      "examples": [
+        [
+          1,
+          2,
+          3
+        ]
+      ],
+      "items": {
+        "type": "integer"
+      },
+      "type": "array"
+    },
+    "project_id": {
+      "description": "Parent project ID",
+      "examples": [
+        1
+      ],
+      "type": "integer"
+    },
+    "starts_at": {
+      "description": "Date and time when the maintenance window starts, with minute precision (seconds must be `00`). Must be within the next year.",
+      "format": "date-time",
+      "type": "string"
+    },
+    "state": {
+      "description": "Maintenance window state",
+      "enum": [
+        "scheduled",
+        "in_progress",
+        "completed",
+        "cancelled"
+      ],
+      "type": "string"
+    },
+    "status_pages": {
+      "description": "List of status page IDs linked to the maintenance window",
+      "examples": [
+        [
+          1,
+          2
+        ]
+      ],
+      "items": {
+        "type": "integer"
+      },
+      "type": [
+        "array",
+        "null"
+      ]
+    },
+    "tags": {
+      "description": "Resource tags, made of lowercase letters, numbers, `.`, `_`, `:` and `-`. An organization can have up to 200 tags.",
+      "items": {
+        "examples": [
+          "environment:production"
+        ],
+        "type": "string"
+      },
+      "type": [
+        "array",
+        "null"
+      ]
+    },
+    "title": {
+      "description": "Maintenance window title",
+      "examples": [
+        "Database upgrade"
+      ],
+      "type": "string"
+    },
+    "updated_at": {
+      "description": "Date of last update for the entity",
+      "format": "date-time",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}

First observedNov 7, 2026

TDQS

A3.5/5.0

Behavior3/5

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

Annotations already establish the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false, openWorldHint=false), so the description's remaining job is modest. It adds which sub-resources are included in the response, which is useful context about payload scope, but says nothing about behavior when the ID is invalid or not found.

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 front-loaded sentence with no filler. The trailing enumeration of returned fields partially duplicates what the output schema already provides, which is the only minor inefficiency.

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?

With an output schema present, rich annotations, and fully documented parameters, the description covers what an agent needs to select and call this tool. Only the absence of error/not-found behavior and explicit sibling routing keeps it below a 5.

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% and both parameters are documented in the schema, so the baseline is 3. The phrase 'by ID' reinforces the maintenance_window_id intent but adds no new meaning, and project_id scoping is left entirely to the schema.

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 names a specific verb and resource ('Get a maintenance window by ID') and enumerates the associated data it returns (state, schedule, monitoring mode, monitors, status pages). It is clearly distinguishable from list_maintenance_windows and the mutation siblings, though it never names those siblings explicitly.

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: 'by ID' suggests this is the single-record lookup versus the list tool, but the description never states when to prefer it over list_maintenance_windows or update_maintenance_window, nor any prerequisites. Adequate but with clear gaps.

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

All Phare tools Inspect

Try in Browser

Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?