Skip to main content
Glama

skycloak_get_realm_export

Read-only

Poll a realm export job by ID after creating it, checking status until completed and retrieving the download URL that expires in 24 hours.

Instructions

Get a realm export job by ID. Poll this after skycloak_create_realm_export until status is 'completed'; the download URL only appears then and expires 24 hours later.

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": {
      "export_id": "<export_id>"
    },
    "name": "skycloak_get_realm_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
export_idYesthe realm export ID

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.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, openWorldHint=false), so the description's job is to add behavioral context, and it does: the download URL is absent until status is 'completed' and expires 24 hours later. It does not describe failure states or polling cadence, leaving some operational gaps.

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, zero filler, and the core action is front-loaded before the polling workflow. Every clause carries information an agent needs (predecessor tool, completion condition, URL expiry).

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 purpose, sequencing, and the key post-completion constraint. For a single-parameter polling tool this is nearly complete; only failure/stuck-job handling is missing.

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% for the single export_id parameter, so the schema already documents the input. The description adds only 'by ID', which restates the schema rather than enriching it. Baseline 3 applies when structured fields carry the parameter meaning.

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 opens with a specific verb and resource: 'Get a realm export job by ID.' The phrase 'realm export job' distinguishes it from the broader skycloak_get_export, but it never states that distinction explicitly, so an agent must infer the boundary from naming alone.

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?

Usage is stated concretely: poll after skycloak_create_realm_export until status is 'completed'. That names the predecessor tool and the terminating condition, which is exactly the workflow context an agent needs. It offers no when-not guidance (e.g., what to do if the job is stuck or failed).

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