Skip to main content
Glama

skycloak_get_smtp

Read-only

Retrieve a realm's SMTP configuration from a Skycloak cluster, excluding secret values, to review email settings without exposing credentials.

Instructions

Get a realm's SMTP configuration (secret values are never returned).

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

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
cluster_idYesthe cluster ID

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

A3.8/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds a real behavioral fact beyond them: secret values are never returned, which tells the agent the response will have redacted fields and prevents it from assuming credentials are retrievable.

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 tight sentence with the resource stated first and the output caveat parenthesized at the end. Nothing is redundant and nothing important is buried.

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, so return-value structure need not be described, and the annotations cover the read-only profile. The only gap is guidance on how this getter relates to the sibling test/upsert/delete SMTP tools, which the description leaves to inference.

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% with only two required parameters (cluster_id, realm), so the schema already carries their meaning. The description adds no scope notes about what a realm name or cluster ID must refer to, so it stays at the baseline for a fully documented schema.

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 names a specific verb and resource: 'Get a realm's SMTP configuration'. The verb distinguishes it by implication from the sibling mutation tools (skycloak_upsert_smtp, skycloak_delete_smtp, skycloak_test_smtp), but it never names or contrasts those alternatives directly.

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: read the SMTP configuration for a given realm. The description does not say when to prefer this over skycloak_test_smtp (checking health/behavior) or skycloak_upsert_smtp (inspection before a change), nor does it mention prerequisites such as permissions on the cluster or realm.

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