Skip to main content
Glama

skycloak_create_export

Starts an asynchronous database export for a cluster; poll the export status until completed to get the download URL. Including credentials requires an encryption password.

Instructions

Start a database export for a cluster. Asynchronous: poll skycloak_get_export until the status is 'completed' to obtain the download URL. Including credentials requires an encryption_password.

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

Input Schema

NameRequiredDescriptionDefault
formatYesexport format: sql or pgdump (case-insensitive)
cluster_idYesthe cluster ID
encryption_passwordNopassword to encrypt the archive (AES-256-CBC); required when include_credentials is true
include_credentialsNoinclude the Keycloak credential tables; requires encryption_password

Output Schema

NameRequiredDescriptionDefault
idYes
formatYes
statusYes
progressYes
expires_atNo
completed_atNo
download_urlNo
is_encryptedYes
error_messageNo
file_size_bytesNo

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 already declare this is a non-read-only, non-idempotent, non-destructive create. The description adds genuinely new behavior: the operation is asynchronous and returns before the archive exists, and including credentials imposes an encryption requirement. It stops short of saying what a duplicate call does, given idempotentHint=false.

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, both load-bearing: the first defines the action, the second defines the follow-up workflow and the credential constraint. The async warning is front-loaded where an agent will act on it.

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 the description covers the async lifecycle and the one conditional requirement. Missing only minor operational detail such as behavior on repeated invocations or failure states, which for this tool is a small gap.

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 documents format values, cluster_id, encryption_password's AES-256-CBC detail, and the include_credentials dependency. The description restates the credentials/encryption dependency without adding syntax or defaults beyond the schema, so it sits at the baseline.

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 ('Start a database export for a cluster') and immediately distinguishes itself from the related read tool skycloak_get_export by naming it as the polling counterpart. An agent can tell what this creates and what it is not.

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?

Explicitly describes the async workflow: start here, then poll skycloak_get_export until status is 'completed' to get the download URL. It also states the conditional prerequisite for credentials. It does not address when to prefer the realm-export alternatives, but within its own flow the guidance is clear.

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