Skip to main content
Glama

skycloak_restart_cluster_instances

Destructive

Restarts a Keycloak cluster's instances to apply pending theme changes, such as replaced content under an exact theme name. Requires confirm=true because live traffic is disrupted.

Instructions

Restart a cluster's Keycloak instances, disrupting live traffic on it. Use this after skycloak_update_theme_settings turns exact_theme_names on: a theme whose content was replaced under its exact name only serves the new content once Keycloak restarts (see restart_required on skycloak_get_theme / skycloak_list_themes). Applies immediately unless the workspace latches disruptive changes to the maintenance window, in which case the result reports deferred=true and, when known, next_window (RFC3339). Returns a conflict when the cluster cannot restart right now: already busy with a restart or other update, not in an available state, or the operator has no environment variable slot left. Set confirm=true to proceed.

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": {
      "cluster_id": "<cluster_id>",
      "confirm": "<confirm>"
    },
    "name": "skycloak_restart_cluster_instances"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmYesmust be true to confirm the restart, which disrupts live traffic on the cluster
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
impactYes
deferredYes
next_windowNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: discloses traffic disruption, immediate-vs-deferred execution under a latched maintenance window, the deferred=true and next_window (RFC3339) signals, and three distinct conflict causes. Annotations already flag destructive/not-idempotent, and the description adds the operational consequences rather than repeating them.

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?

Front-loaded with the action and its blast radius, then the trigger, then the deferred/conflict semantics. Dense but largely earned; the nested multi-clause conflict sentence is the only mild readability cost.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite an existing output schema, the description still surfaces the two return signals an agent must branch on (deferred, next_window) plus the conflict case. Combined with the confirm gate and maintenance-window caveat, nothing required to invoke or interpret the call is missing.

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 100% and the schema already documents both confirm and cluster_id, including that confirm gates a disruptive restart. The description restates 'Set confirm=true to proceed' without adding new syntax or constraints, so it sits at the baseline for fully-covered schemas.

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?

The description opens with a specific verb and resource ('Restart a cluster's Keycloak instances') and immediately states the consequence ('disrupting live traffic'). It also pins down the trigger scenario (post skycloak_update_theme_settings with exact_theme_names on), which distinguishes it from all read/update siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit when-to-use: after skycloak_update_theme_settings turns exact_theme_names on, cross-referenced to restart_required on skycloak_get_theme / skycloak_list_themes. It also enumerates when the call will not go through (busy cluster, unavailable state, no env var slot), which is the 'when-not' half agents need.

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

Deploy Server

Other Tools