Skip to main content
Glama

skycloak_upsert_email_branding

Idempotent

Create or update Keycloak realm email-template branding—colors, light/dark logos, company URL, and footer text—while preserving any fields you omit.

Instructions

Create or update email-template branding: color, light and dark logos, company URL and footer text. 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_email_branding"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
cluster_idYesthe cluster ID
company_urlNocompany website linked from the footer
footer_textNofree text in the footer
primary_colorNoprimary accent color (hex)
footer_company_nameNocompany name in the footer
header_logo_dark_urlNologo URL for dark email clients
header_logo_light_urlNologo URL for light email clients

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.8/5.0
Behavior4/5

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

Annotations already declare readOnly=false, idempotent=true, and non-destructive. The description adds genuinely new behavioral information not in the annotations: the merge/patch semantics that omitted fields retain their current value, which matters for an upsert. It does not cover permission requirements or how explicit nulls are treated, keeping 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, both front-loaded, with zero filler. The identity of the resource comes first and the partial-update caveat follows immediately.

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, annotations covering the safety profile, and fully described parameters, the description supplies what is missing. The only residual gap is unstated handling of explicit nulls versus omitted fields, and which realm/cluster scope the branding applies to beyond what the required params already convey.

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 all eight parameters are already documented in the schema, and the description's field list maps onto the same properties without adding format or validation detail. Baseline 3 applies when the schema does the heavy lifting.

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 gives a specific verb pair and resource ('Create or update email-template branding') and enumerates the fields it manages (color, light/dark logos, company URL, footer text). The 'email-template' qualifier implicitly separates it from the login-branding sibling, though no sibling is named explicitly.

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: call this to create or modify email branding, and 'Fields you omit keep their current value' tells the agent partial updates are safe without a prior read. However, there is no guidance on when to prefer it over get/delete email branding, nor any stated prerequisites or when-not conditions.

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