Skip to main content
Glama

skycloak_get_export

Read-only

Retrieve a database export job by ID to check its status and progress, and get the time-limited download URL once completed.

Instructions

Get a database export job by ID, including its status, progress, and (once completed) the time-limited download URL.

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

Input Schema

NameRequiredDescriptionDefault
export_idYesthe export job ID
cluster_idYesthe cluster ID

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

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description does add useful behavior beyond the annotations: that progress is reported incrementally and the download URL only appears once completed and is time-limited. It does not clarify how long the URL remains valid or how to refresh it, and idempotentHint=false is left unexplained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single well-formed sentence with the resource identifier front-loaded and the return highlights second. Every clause carries information, though the parenthetical could be tightened.

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?

With an output schema covering return values and annotations covering the read-only profile, a single sentence is close to sufficient. The remaining gap is lifecycle detail around the time-limited URL, which matters for correct invocation but is arguably delivered by the output schema.

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 description coverage is 100%, and the description adds nothing beyond 'by ID' for either parameter. The baseline of 3 applies since the schema carries the parameter documentation.

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 states a specific verb and resource ('Get a database export job by ID') and scopes it to database exports, which separates it from the sibling realm-export tools. It stops short of explicitly naming the sibling to avoid, so it falls one step below a fully differentiating statement.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The mention of status, progress, and a download URL implies the polling/retrieval use case, and pairing with create/delete export tools is inferable. However, there is no explicit when-to-use or when-not-to-use guidance and no named alternative.

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