Skip to main content
Glama

skycloak_create_realm_export

Export a Keycloak realm to an encrypted archive. Provide an encryption password, then poll the export status until completion to retrieve the file.

Instructions

Export a Keycloak realm to an encrypted archive. Asynchronous: poll skycloak_get_realm_export until status is 'completed'. The archive is always encrypted, so encryption_password is required, and the same password is needed to import it again. This is a realm export (one realm's configuration); skycloak_create_export is the separate whole-cluster database export.

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>",
      "realm": "<realm>",
      "encryption_password": "<encryption_password>"
    },
    "name": "skycloak_create_realm_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe realm to export
cluster_idYesthe cluster ID
encryption_passwordYespassword used to encrypt the archive; required, and needed again to import it

Output Schema

NameRequiredDescriptionDefault
idYes
realmYes
scopeYes
statusYes
progressYes
cluster_idYes
created_atNo
expires_atNo
completed_atNo
download_urlNo
error_messageNo
source_versionNo
sha256_checksumNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations only give the safety profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false); the description adds the genuinely novel facts: the call is asynchronous and returns before the archive exists, and the archive is always encrypted with the supplied password. It does not address what happens on repeated calls (consistent with idempotentHint=false) or where the archive is delivered, but the async contract is the key disclosure an agent needs.

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?

Three sentences, each earning its place: what it does, how to await completion, and how it differs from the similarly named cluster export. Async behavior and the sibling disambiguation are front-loaded rather than buried.

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?

Covers everything an agent needs for a 3-required-parameter async mutation: the mandatory encryption password, the polling partner tool and terminal status, and the distinction from skycloak_create_export. Return-value shape is covered by the existing output schema, so omitting it is correct.

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 each parameter already carries its own description, including the encryption_password import consequence. The description restates rather than extends that meaning, so the baseline 3 is appropriate.

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?

Opens with a specific verb+resource+output ('Export a Keycloak realm to an encrypted archive') and explicitly contrasts itself with skycloak_create_export as the whole-cluster database export, so the agent can pick the right one without opening schemas.

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?

States the operational flow explicitly (asynchronous — poll skycloak_get_realm_export until status 'completed') and names the sibling it is not. The hard prerequisite (encryption_password required, reused on import) is stated up front rather than 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