Skip to main content
Glama

skycloak_get_email_branding

Read-only

Retrieve a Keycloak realm's email-template branding, including colors, logo, and footer, to review or verify how its emails appear.

Instructions

Get the email-template branding (colors, logo, footer) 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_email_branding"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
statusYes
primary_colorNo
footer_company_nameNo
header_logo_light_urlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds only the field list (colors, logo, footer); it says nothing about required permissions, what happens if a realm has no custom branding, or error behavior.

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 sentence with the resource and returned fields front-loaded; 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?

With an output schema present, return-value explanation is unnecessary, and annotations cover the read-only safety profile; the description is adequate for a simple two-parameter getter. Only minor context, such as behavior for realms without custom branding, is absent.

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% and both parameters (cluster_id, realm) are documented in the schema. The description only echoes 'for a realm', adding no format, default, or scoping detail beyond what the schema provides, so the 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?

States a specific verb and resource ('Get the email-template branding') and enumerates the fields returned (colors, logo, footer), which lets an agent distinguish it from get_login_branding or get_smtp. It does not explicitly name a sibling or contrast scope, so it falls short of 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 Guidelines3/5

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

The resource is narrow enough that its use is implied, but there is no explicit statement of when to use this versus get_login_branding or upsert_email_branding. No prerequisites (cluster access, realm existence) are mentioned.

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