Skip to main content
Glama

skycloak_create_domain_route

Add a realm route to a custom domain so a chosen realm is reachable through that domain; avoid the reserved master realm, which the API rejects.

Instructions

Add a realm route to a custom domain. Never use the master realm; it is reserved for cluster management and the API rejects it.

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>",
      "domain_id": "<domain_id>",
      "realm": "<realm>"
    },
    "name": "skycloak_create_domain_route"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe realm to route to this domain
domain_idYesthe domain ID
cluster_idYesthe cluster ID
hide_realm_pathNowhether to omit the /realms/{name} path segment
allow_admin_accessNowhether the admin console is reachable via this domain

Output Schema

NameRequiredDescriptionDefault
idYes
realmYes
hide_realm_pathYes
allow_admin_accessYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare this is a write operation that is not idempotent and not destructive. The description adds useful behavioral context: the master realm is reserved for cluster management and the API rejects routing to it. It does not add further details about permissions, side effects, or conflict handling.

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, front-loaded with the action and followed by the critical validity rule. Every sentence earns its place with no filler.

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?

The definition is complete enough for a create-route tool: purpose is clear, the critical master-realm restriction is stated, annotations cover mutation safety, the schema covers all parameters, and an output schema exists. It could be stronger with brief context about domain prerequisites or behavior when a route already exists, but those are secondary.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds a meaningful validity constraint for the realm parameter by prohibiting the master realm, which is not captured in the schema's generic parameter description. It does not explain the optional hide_realm_path or allow_admin_access flags.

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?

"Add a realm route to a custom domain" states a specific verb and resource, making it clear this creates a routing association rather than a domain, cluster, or realm. It does not explicitly contrast with sibling tools such as update_domain_route or create_domain, so a 4 rather than a 5.

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?

The description gives an important when-not condition: never use the master realm because the API rejects it. It does not discuss when to use this instead of update_domain_route or other route-related siblings, so it is strong but not fully explicit about alternatives.

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