Skip to main content
Glama

skycloak_get_login_branding

Read-only

Retrieves login-page branding settings—colors, logo, and toggles—for a specified Keycloak realm and cluster.

Instructions

Get the login-page branding (colors, logo, toggles) for a realm.

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_get_login_branding"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
cluster_idYesthe cluster ID

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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and idempotentHint=false, so the safety profile is covered. The description adds what the payload conceptually contains (colors, logo, toggles), but says nothing about default/unset branding behavior, realm-level permissions, or whether the cluster must be active.

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?

A single front-loaded sentence with the resource and its scope, plus a parenthetical listing the returned content. No filler or redundant restatement of the title.

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?

An output schema exists and annotations cover safety, so the description need not explain return values; for a two-parameter getter it is close to complete. The only gap is any note on fallback behavior when branding is unset, which matters for a getter whose result may be partial.

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% with both required parameters documented, so the baseline applies. The description's phrase "for a realm" loosely reinforces the realm parameter but adds nothing about cluster_id or the relationship between the two identifiers.

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?

States a specific verb and resource ("Get the login-page branding") and enumerates the contents (colors, logo, toggles), which distinguishes it from the sibling email-branding getters by scope. It does not name the delete/upsert counterparts, but the read intent is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no when-to-use guidance, no prerequisites, and no pointer to skycloak_upsert_login_branding or skycloak_get_email_branding. The read-only nature is implied by "Get" but the agent must infer when this tool is the right call.

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