Skip to main content
Glama

skycloak_update_cluster

Idempotent

Update a cluster's Keycloak version to trigger an upgrade or change instance size, and optionally toggle automatic patch upgrades.

Instructions

Update a cluster's version (to trigger an upgrade) or size.

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>"
    },
    "name": "skycloak_update_cluster"
  }
}

Input Schema

NameRequiredDescriptionDefault
sizeNonew instance size: small, medium, or large (case-insensitive)
versionNotarget Keycloak version (triggers an upgrade)
cluster_idYesthe cluster ID
auto_upgrade_enabledNoenable or disable automatic patch upgrades

Output Schema

NameRequiredDescriptionDefault
IDYes
URLYes
NameYes
SizeYes
TypeYes
StatusYes
VersionYes
LocationYes
CreatedAtYes
UpdatedAtYes
AutoUpgradeEnabledYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavior — that setting version triggers an actual upgrade — but says nothing about partial-update semantics (are unspecified fields left untouched?), downtime during an upgrade, or how auto_upgrade_enabled interacts with a version bump.

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?

A single front-loaded sentence that states the two mutation paths immediately, with the clarifying parenthetical placed right where it matters. No filler or redundancy.

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

Completeness3/5

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

An output schema and full schema coverage relieve the description of return-value and parameter duties, but for a mutation tool with four fields it omits the auto_upgrade_enabled mode entirely and doesn't clarify merge-vs-replace semantics or upgrade side effects. Adequate to call the tool, not complete.

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 all four parameters including size's allowed values and version's upgrade trigger are already documented in the schema. The description only restates version and size and adds nothing about auto_upgrade_enabled, 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?

The description names a specific verb and resource ('Update a cluster's version... or size') and adds the causal detail that changing version triggers an upgrade. It is clearly a cluster mutation, distinct from siblings like cancel_cluster_upgrade or get_cluster_upgrade_path, though it never mentions the auto_upgrade_enabled capability the schema exposes.

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: an agent can infer this is the tool for changing size or version, but the description gives no explicit conditions, no prerequisites, and no routing to adjacent tools such as skycloak_get_cluster_upgrade_path (to check the path first) or skycloak_cancel_cluster_upgrade.

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