Skip to main content
Glama

skycloak_upsert_login_branding

Idempotent

Create or update Keycloak login branding: colors, logo, favicon, font, policy links, and registration, remember-me, forgot-password, and badge toggles. Omitted fields keep current values.

Instructions

Create or update login-page branding: colors, logo, favicon, font, terms and privacy links, the registration, remember-me, forgot-password and Powered by Skycloak toggles. Fields you omit keep their current value.

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

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
font_urlNocustom web font URL
logo_urlNologo URL
cluster_idYesthe cluster ID
favicon_urlNofavicon URL
primary_colorNoprimary accent color (hex)
show_powered_byNodisplay the Powered by Skycloak badge
background_colorNobackground color (hex)
privacy_policy_urlNoprivacy policy URL linked from the login page
remember_me_enabledNoshow the remember-me checkbox
registration_enabledNoshow the self-registration link
terms_of_service_urlNoterms of service URL linked from the login page
forgot_password_enabledNoshow the forgot-password link

Output Schema

NameRequiredDescriptionDefault
statusYes
logo_urlNo
primary_colorNo
background_colorNo
registration_enabledYes
forgot_password_enabledYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so the safety profile is partly covered. The description adds a genuinely useful behavioral fact beyond them: 'Fields you omit keep their current value,' which clarifies patch-style merge semantics and explains how partial updates interact with the non-destructive, idempotent profile. It still says nothing about permissions or whether a previously set field can be cleared (e.g. by passing null).

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, zero filler, with the core verb-and-resource statement front-loaded and the patch-semantics rule placed immediately after. The field list is dense but each item maps to a real parameter, so nothing is wasted.

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 13 parameters, an output schema present, and annotations covering safety and idempotency, the description supplies what the structured fields cannot: the merge-on-omit rule. What is missing is minor for call correctness — the ability to unset a field and any permission or scope requirement — but the tool is otherwise adequately framed.

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%, so every one of the 13 parameters is already documented in the input schema. The description's field enumeration ('colors, logo, favicon, font, terms and privacy links... toggles') mirrors the schema properties without adding format or constraint detail, so baseline 3 applies.

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 pairs a specific verb ('Create or update') with a specific resource ('login-page branding') and enumerates the configurable surface, so the agent can tell it apart from skycloak_get_login_branding and skycloak_delete_login_branding. It does not explicitly name the sibling upsert_email_branding as the contrasting case, so differentiation from the email-branding tool is only implied by the word 'login-page'.

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?

Usage is implied through 'Create or update' and the omit-keeps-current-value clause, which tells the agent this is the single write path for login branding. However, there is no explicit when-to-use or when-not-to-use guidance, no mention of prerequisites (e.g. the branding must already exist vs. is created), and no pointer to the get/delete siblings.

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