Skip to main content
Glama

skycloak_create_cluster

Provisions a new Keycloak cluster asynchronously, returning it in provisioning state; poll skycloak_get_cluster until its status becomes available.

Instructions

Provision a new Keycloak cluster. Asynchronous: the returned cluster starts in a provisioning state — poll skycloak_get_cluster until its status is 'available'. Requires --allow-writes.

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": {
      "name": "<name>",
      "size": "<size>",
      "version": "<version>",
      "location": "<location>"
    },
    "name": "skycloak_create_cluster"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYeshuman-readable cluster name
sizeYesinstance size: small, medium, or large (case-insensitive)
typeNocluster type: keycloak or tidecloak (case-insensitive); defaults to keycloak
versionYesKeycloak version, e.g. 26.1
locationYesregion: us (US East), us-west (US West, only for workspaces granted access), ca, au, or eu (case-insensitive); skycloak_list_cluster_locations shows which ones this workspace can use
auto_upgrade_enabledNoenable automatic patch upgrades
maintenance_window_enabledNowhether the creation maintenance window is active
maintenance_window_timezoneNomaintenance-window IANA timezone, e.g. Europe/Berlin
maintenance_window_end_localNomaintenance-window local end time in HH:MM format
maintenance_window_start_localNomaintenance-window local start time in HH:MM format
maintenance_window_days_of_weekNomaintenance-window days, 0=Sunday through 6=Saturday

Output Schema

NameRequiredDescriptionDefault
idYes
urlNo
nameYes
sizeYes
typeYes
statusYes
versionYes
locationYes
created_atNo
updated_atNo
auto_upgrade_enabledYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations only declare that this is a non-read-only, non-idempotent, non-destructive write; the description adds the crucial behavioral fact that the call is asynchronous and returns a cluster in a 'provisioning' state that must be polled. It also discloses the --allow-writes permission requirement, which the annotations do not capture. It does not cover failure modes such as name collisions, so it is not fully complete.

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 front-loaded sentences: the action first, then the async contract and next step. Every clause carries actionable information with no repetition of the schema.

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?

An output schema exists, so return values need not be described, and the async lifecycle plus permission prerequisite cover the main uncertainties for a create tool. Only edge cases such as duplicate names or partial provisioning failure are left unaddressed.

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 11 parameters are already documented, including the enum-like values for size, type, and location. The description adds no parameter-level meaning beyond what the schema states, so the 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 and resource ('Provision a new Keycloak cluster'), which unambiguously separates it from the many other create_* siblings that target applications, realms, domains, and roles. No ambiguity about what object is being created.

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 post-call workflow (poll skycloak_get_cluster until status is 'available') and a prerequisite (--allow-writes), which is real when-to-use context. It stops short of naming when a caller should choose a different creation path, but the resource scope is narrow enough that this is a minor gap.

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