Skip to main content
Glama

skycloak_create_realm_import

Import a Keycloak realm into a cluster from an uploaded archive or existing export. Creates the realm with its users and credentials; a name collision is refused instead of overwriting.

Instructions

Import a Keycloak realm into a cluster from an uploaded archive or an existing realm export. Asynchronous: poll skycloak_get_realm_import. Creates a new realm: preflight refuses a name collision rather than overwriting, so an existing realm of the same name fails with 409. It does import users and their credentials, so 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_create_realm_import"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmYesmust be true: the import creates a realm complete with users and credentials
passwordNopassword that decrypts the archive; required for an encrypted one
cluster_idYesthe cluster ID to import into
upload_s3_keyNos3_key from skycloak_create_realm_import_upload_url, after uploading the archive
source_export_idNoID of an existing realm export to import instead of an upload

Output Schema

NameRequiredDescriptionDefault
idYes
realmYes
statusYes
progressYes
cluster_idYes
created_atNo
source_kindYes
completed_atNo
error_messageNo
source_versionNo
target_versionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false and destructiveHint=false; the description usefully adds async polling behavior and the 409 preflight refusal on name collision, which is consistent with the non-idempotent/non-destructive profile. It also flags that users and credentials are imported (hence confirm=true), but says nothing about what happens to the uploaded archive afterwards or whether a failed import leaves partial state. Solid added context with a remaining behavioral gap, so a 3.

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?

Four short sentences, front-loaded with the action, then async behavior, then the collision rule, then the confirmation requirement. No filler and no repetition of the title.

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?

The tool is a state-changing, asynchronous import with five parameters but a full schema and an output schema, so return values need no explanation. The description covers the source selection, the polling follow-up, the collision outcome, and the confirmation gate, leaving nothing an agent needs before calling it.

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%, so the schema already explains confirm, password, cluster_id, upload_s3_key and source_export_id, including the note that upload_s3_key comes from skycloak_create_realm_import_upload_url. The description reinforces the confirm gate and the upload-vs-export choice but adds no syntax or format detail beyond the schema. 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 (import a Keycloak realm into a cluster) and enumerates both sources: an uploaded archive or an existing realm export. This clearly separates it from the sibling skycloak_create_realm plus skycloak_create_realm_import_upload_url, which is named as the upstream step.

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 explicit operating context: asynchronous, so poll skycloak_get_realm_import; a name collision fails with 409 rather than overwriting; confirm=true is required. It does not explicitly contrast with skycloak_create_realm for the fresh-creation case, which is the only 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