Skip to main content
Glama

skycloak_update_theme_content

DestructiveIdempotent

Replaces a theme's archive in place to update its content while preserving its ID, name, and assignments, avoiding the unbranded gap from deleting and re-uploading.

Instructions

Replace an existing theme's archive with a new one, in place. The theme keeps its ID, its name and every realm and application assignment, and the new content deploys immediately, so this is the way to edit a theme: deleting and re-uploading detaches it and leaves the sign-in page unbranded in between. Pass the ZIP or Keycloakify JAR base64-encoded in content_base64. Set confirm=true to proceed: the archive being replaced is not recoverable afterwards. The replacement must still contain every theme type the theme provides today, or the API rejects it; a theme created by a platform migration has pinned content and answers 409. When the workspace has exact_theme_names on (see skycloak_get_theme_settings), this sets restart_required=true on the theme until skycloak_restart_cluster_instances applies 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>",
      "content_base64": "<content_base64>",
      "confirm": "<confirm>"
    },
    "name": "skycloak_update_theme_content"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmYesmust be true to confirm the current archive is overwritten, which cannot be undone
versionNonew version label to record once the content is live, e.g. v2.4; omit to keep the current one
filenameNoarchive filename; a .jar name is sent as a Keycloakify JAR, anything else as a ZIP (default theme.zip)
theme_idYesthe ID of the theme whose content is replaced
cluster_idYesthe cluster ID
content_base64Yesthe replacement theme archive (ZIP or Keycloakify JAR) base64-encoded

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

A4.6/5.0
Behavior5/5

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

Annotations already flag this as destructive, non-read-only and idempotent, and the description still adds real value: which attributes survive the replacement, that content goes live immediately, that the overwritten archive is unrecoverable, that the replacement must cover every existing theme type, the 409 behavior for migrated themes, and the restart_required side effect under exact_theme_names.

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?

Front-loaded with the operation and its rationale, then progressively adds constraints and side effects; nearly every sentence carries information. It is dense and somewhat long, with parenthetical cross-references, but nothing is clearly wasted.

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?

For a destructive write tool this covers purpose, safety consequences, rejection cases, and follow-up actions, and an output schema exists so return values need no explanation. An agent has everything required to call it correctly or to decide not to.

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%, so all six parameters are already documented, and the description largely restates them (content_base64 accepts ZIP or Keycloakify JAR, confirm must be true). The only added meaning is the consequence framing around confirm and the link between archive contents and API rejection, which is modest given how complete the schema already is.

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?

"Replace an existing theme's archive with a new one, in place" names the exact resource (theme archive) and operation (in-place replacement), and immediately separates it from the delete/re-upload pattern and, implicitly, from metadata updates via skycloak_update_theme by stressing that ID, name and assignments are preserved.

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 states this is the preferred way to edit a theme and names the worse alternative (delete + re-upload) with its consequence (detached theme, unbranded sign-in page). It also gives the failure conditions (theme type mismatch, 409 on migration-created pinned themes) and routes the agent to skycloak_get_theme_settings and skycloak_restart_cluster_instances when exact_theme_names is on.

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