Skip to main content
Glama

skycloak_create_realm

Creates a new Keycloak realm in a specified Skycloak cluster, requiring a write-enabled server and a write-scoped API key.

Instructions

Create a new Keycloak realm in a cluster. Requires the server to be started with --allow-writes and a write-scoped API key.

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

Input Schema

NameRequiredDescriptionDefault
nameYesthe realm name (unique within the cluster)
cluster_idYesthe cluster to create the realm in
display_nameNooptional human-readable display name

Output Schema

NameRequiredDescriptionDefault
nameYes
enabledYes
cluster_idYes
cluster_nameNo
display_nameNo
ssl_requiredNo
registration_allowedYes
default_branding_appliedNo
login_with_email_allowedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and idempotentHint=false, so the mutation profile is covered structurally. The description adds the non-obvious operational context the annotations cannot express: the environment gate (--allow-writes) and the credential scope (write-scoped API key), implying the call fails otherwise. It does not mention behavior on a duplicate realm name, though the schema covers uniqueness.

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, front-loaded with the action and followed by the precondition. Nothing is redundant with the title or schema, and no sentence could be removed without losing required information.

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 explained, and annotations carry the safety profile. The remaining essentials for a create operation — prerequisites and target scope — are present. It is slightly thin on failure modes (name collision, disabled writes response), which would round it out.

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%, with each of the three parameters described inline, so the baseline is 3. The description adds no parameter-level meaning beyond the schema — it does not clarify naming rules, display_name fallback behavior, or how cluster_id is validated.

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 ('Create a new Keycloak realm') and scopes it to 'in a cluster', which separates it from the realm sub-resource creation tools (realm_user, realm_role, realm_group) in the sibling list. It stops short of explicitly contrasting with siblings like skycloak_create_realm_import, but the resource is unambiguous.

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?

The definition supplies real preconditions — the server must run with --allow-writes and the API key must be write-scoped — which an agent needs before attempting the call. However, it gives no when-to-use-vs-alternative guidance (e.g. import vs create, or how it relates to skycloak_create_cluster), so selection among siblings is left to inference.

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