Skip to main content
Glama

skycloak_create_realm_import_upload_url

Get a presigned URL to upload a realm archive for import. PUT the archive to the URL, then pass the returned S3 key to the realm import step.

Instructions

Get a presigned URL to upload a realm archive to. PUT the archive to upload_url, then pass the returned s3_key to skycloak_create_realm_import as upload_s3_key. Not needed when importing an existing export: pass that export's ID as source_export_id instead.

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

Input Schema

NameRequiredDescriptionDefault
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
s3_keyYes
upload_urlYes

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 declare a non-read-only, non-destructive, non-idempotent operation; the description adds the real behavioral context — that the tool only mints a URL, the actual upload happens client-side, and the URL is single-purpose feeding into another tool. It does not mention URL expiry, size or permission constraints, which keeps it short of a 5. No contradiction with readOnlyHint=false, since minting an upload target is a state-changing action.

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 load-bearing: purpose first, workflow second, alternative path third. No filler and the most important routing information is front-loaded.

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?

An output schema exists, so return values need not be enumerated, yet the description still names the two fields the caller must act on (upload_url, s3_key), closing the loop with the downstream tool. Nothing an agent needs in order to call this correctly 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?

There is a single parameter with 100% schema description coverage, so the schema already documents cluster_id. The description adds nothing further about the parameter, which is the expected baseline 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 — obtaining a presigned upload URL for a realm archive — and immediately distinguishes itself from skycloak_create_realm_import, which consumes the result. An agent can tell exactly what this tool produces 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?

Gives an explicit multi-step procedure (PUT the archive to upload_url, then pass s3_key to skycloak_create_realm_import) and an explicit exclusion: not needed when importing an existing export, use source_export_id instead. When-to-use, how-to-use, and when-not-to-use are all covered.

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