Skip to main content
Glama

skycloak_test_smtp

Send a test email through a Keycloak realm's configured SMTP server to verify delivery to a specified recipient.

Instructions

Send a test email through a realm's configured SMTP server to verify delivery.

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>",
      "email": "<email>"
    },
    "name": "skycloak_test_smtp"
  }
}

Input Schema

NameRequiredDescriptionDefault
emailYesrecipient email address for the test message
realmYesthe Keycloak realm name
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
messageNo
successYes

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=false, idempotentHint=false, and openWorldHint=true, so the agent knows this causes an external side effect. The description usefully clarifies that it transmits a real message via the realm's configured server, but says nothing about failure behavior (SMTP unconfigured, auth errors, rate limits) or that repeated calls send repeated emails.

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; the action and purpose come first. It is arguably terse for a tool with an external side effect, but nothing is wasted.

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

Completeness3/5

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

An output schema exists, so return values need no explanation, and the annotations cover the side-effect profile. However, for a tool that fires a real email, the definition omits the configuration prerequisite and any expected outcome on success or failure, leaving meaningful gaps.

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%, so all three parameters (cluster_id, realm, email) are already documented in structured data. The description adds no syntax, format, or constraint detail beyond implying that 'email' is the recipient of the test message — 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?

Specific verb (send a test email) plus resource (realm's configured SMTP server) plus goal (verify delivery). It implicitly separates itself from configuration siblings by saying 'configured SMTP server' (i.e., it uses existing config rather than setting it), but it never names an alternative tool.

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 only implied: the agent can infer it should run this after SMTP settings exist to verify delivery. There is no explicit when-to-use/when-not, no prerequisite stated (e.g., SMTP must first be set via skycloak_upsert_smtp), and no guidance versus skycloak_get_smtp or the other test_* 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