Skip to main content
Glama

skycloak_get_realm_import

Read-only

Retrieve a realm import job by ID to poll its progress after creating an import, checking until the status is completed or failed.

Instructions

Get a realm import job by ID. Poll this after skycloak_create_realm_import until status is 'completed' or 'failed'.

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": {
      "import_id": "<import_id>"
    },
    "name": "skycloak_get_realm_import"
  }
}

Input Schema

NameRequiredDescriptionDefault
import_idYesthe realm import ID

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

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds the non-obvious fact that this is a polling endpoint with terminal states. It does not mention polling cadence, how long completed job records remain retrievable, or what a not-found/pending response looks like.

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, with the core purpose first and the polling instruction second. Every clause carries operational value.

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?

Output schema exists, so return values need no explanation, and the polling lifecycle is covered. Minor gaps remain around polling frequency/backoff and whether job records expire, which would help an agent drive the loop correctly.

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 the single import_id parameter is fully documented in the schema. The phrase 'by ID' merely restates the required key and adds no format or provenance detail. Baseline 3 applies when the schema does the work.

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 ('Get a realm import job') plus the lookup key ('by ID'), which cleanly separates it from skycloak_create_realm_import and skycloak_get_realm_export. An agent can identify the tool's job without opening the schema.

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?

Explicitly prescribes the workflow: poll after skycloak_create_realm_import until status is 'completed' or 'failed'. This names the predecessor tool and the terminating conditions, leaving nothing 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