Skip to main content
Glama

skycloak_upsert_smtp

Idempotent

Create or update a Keycloak realm's SMTP configuration with basic authentication, including server host, port, sender details, and optional credentials.

Instructions

Create or update a realm's SMTP configuration (basic auth).

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>",
      "host": "<host>",
      "port": "<port>",
      "from_email": "<from_email>"
    },
    "name": "skycloak_upsert_smtp"
  }
}

Input Schema

NameRequiredDescriptionDefault
hostYesSMTP server hostname
portYesSMTP server port (e.g. 587)
realmYesthe Keycloak realm name
passwordNoSMTP password (basic auth); omit to retain the stored value
usernameNoSMTP username (basic auth)
from_nameNosender display name
cluster_idYesthe cluster ID
encryptionNoencryption mode: none, ssl, or starttls (case-insensitive)
from_emailYessender email address

Output Schema

NameRequiredDescriptionDefault
hostYes
portYes
statusNo
auth_typeYes
from_nameNo
encryptionNo
from_emailYes
has_passwordYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/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 covered. The description adds the meaningful constraint that this configures basic auth specifically, but says nothing about what happens to unspecified fields (merge vs replace), whether an existing config is overwritten wholesale, or whether credentials are validated on write.

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?

A single front-loaded sentence with no filler and the resource stated first. It is efficient, though the terseness is achieved partly by omitting useful information rather than by tight editing of a richer text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a nine-parameter mutation with no annotations gap on safety but a real gap on effect: the description never explains whether the upsert replaces the entire SMTP config or merges into it, nor what happens when required fields conflict with an existing configuration. The output schema covers return values, but the write semantics remain underspecified for a tool of this complexity.

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 nine parameters is already documented, including the important 'omit to retain the stored value' behavior for password. The description's '(basic auth)' note reinforces that username/password are the auth mechanism but adds no syntax, defaults, or constraints beyond the schema; 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 gives a specific verb pair ('Create or update') plus the exact resource ('a realm's SMTP configuration') and a scope qualifier ('basic auth'). An agent can tell this is a write tool for SMTP settings, though it never names the read/test/delete siblings it sits alongside.

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 only usage signal is the implicit 'create or update' upsert semantics. There is no statement of when to reach for this versus skycloak_get_smtp, skycloak_test_smtp, or skycloak_delete_smtp, and no prerequisites such as cluster/realm existence or the need to verify settings before/after.

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