Skip to main content
Glama
Sign In
keycloak-mcp-server

keycloak-mcp-server

by thebylito
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

get-realm-settings

Retrieve a realm's detailed settings to review its configuration, policies, and parameters.

Instructions

Retrieve detailed settings of 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": {
      "realm": "<realm>"
    },
    "name": "get-realm-settings"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesRealm name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description must disclose side effects and safety. The verb 'Retrieve' implies a read-only operation, which is transparent about non-destructive behavior. However, it does not mention error handling, permissions, or response format, leaving some ambiguity.

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?

The description is a single sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and wastes no space.

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?

Given the low complexity (one parameter, no output schema), the description is adequate but minimal. It says 'detailed settings' but does not enumerate what those settings include or hint at return values. For a simple get tool, this is sufficient but not comprehensive.

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?

The input schema already provides full coverage for the single parameter 'realm' with description 'Realm name'. The tool description does not add any extra parameter semantics beyond what the schema states, so it meets the baseline but provides no additional value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses the specific verb 'Retrieve' and identifies the resource as 'detailed settings of a realm', which clearly distinguishes it from sibling tools like list-realms (listing all realms) and update-realm (modifying settings). It is concise and unambiguous.

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 description implies usage for fetching a specific realm's settings but does not explicitly state when to use it versus alternatives like list-realms or update-realm. There is no mention of exclusions or conditions, so it relies on the tool name and context.

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