Skip to main content
Glama

skycloak_get_theme

Read-only

Fetches a custom Keycloak theme by cluster and theme ID and reports if a cluster restart is needed to apply replaced theme content.

Instructions

Get a custom theme by ID. restart_required is true when the theme's content was replaced under its exact name (see skycloak_get_theme_settings) and Keycloak has not restarted since, so the previous content may still be live; use skycloak_restart_cluster_instances to apply 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>",
      "theme_id": "<theme_id>"
    },
    "name": "skycloak_get_theme"
  }
}

Input Schema

NameRequiredDescriptionDefault
theme_idYesthe theme ID
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
idYes
nameYes
statusYes
versionNo
file_sizeYes
theme_typesYes
restart_requiredNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/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 bar is lower, yet the description adds a genuinely non-obvious behavioral trait: the returned content may be stale until a cluster restart. It does not mention error behavior when the theme ID doesn't exist or permission requirements, which keeps it below a 5.

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?

Two sentences, front-loaded with the core action, and every clause in the second sentence carries meaning about the restart_required flag. The second sentence is dense but not padded; it could be split for readability, which is the only knock.

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?

For a simple two-parameter read with an output schema and full annotation coverage, the description covers purpose plus the one surprising semantic in the response. Only minor gaps remain, such as not-found behavior or whether the returned content is the live or stored version.

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% with only two simple identifiers, so the schema already carries both parameters and the baseline of 3 applies. The description adds the notion that theme_id identifies a theme by its exact name (relevant to the restart_required caveat) but contributes no format or scoping detail beyond the schema.

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+resource: 'Get a custom theme by ID,' which is unambiguous and distinguishable from mutation siblings like update_theme or update_theme_content. It also points at skycloak_get_theme_settings for the settings counterpart, giving partial sibling differentiation, though it doesn't clarify the boundary with download_theme_content or get_theme_assignment.

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?

It gives clear operational context: if restart_required is true, the theme content was replaced under the same name and the old content may still be live, and it names skycloak_restart_cluster_instances as the follow-up action. What's missing is any explicit statement of when to choose this tool over the closely related get_theme_settings or download_theme_content.

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