Skip to main content
Glama
paoloamato2

Keycloak MCP Server

by paoloamato2

partial_export_realm

Export selected parts of a Keycloak realm configuration, such as clients, groups, and roles, for backup or migration.

Instructions

Partial export of the realm configuration.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
realmYesRealm name
exportClientsNoIf true, export clients
exportGroupsAndRolesNoIf true, export groups and roles
Behavior2/5

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

No annotations are provided, so the description carries the full burden of disclosing behavior. 'Export' suggests a read operation, but it doesn't clarify side effects (e.g., does it create a file? Return data? Modify state?). The description is silent on output format, atomicity, or any constraints. Minimal transparency.

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?

The description is a single sentence of six words, which is concise. However, it sacrifices completeness for brevity. It is front-loaded with the core purpose but lacks elaboration. A sentence longer but more informative would be better, but conciseness alone is not penalized heavily.

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?

Given the lack of output schema and annotations, the description should compensate by explaining the nature of 'partial export', how the boolean parameters interact, and what the result looks like. The tool has 3 parameters and is part of a large set of sibling tools; the description fails to provide sufficient context for correct usage.

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% with descriptions for all three parameters (realm, exportClients, exportGroupsAndRoles). The description adds no additional meaning beyond the schema, as it merely repeats the concept of 'partial export'. Baseline 3 is appropriate for high schema coverage.

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

Purpose3/5

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

The description 'Partial export of the realm configuration' specifies the verb 'export' and resource 'realm configuration', but 'partial' is vague and doesn't clarify what is included. The input schema parameters hint at selective export, but the description does not explicitly state that it exports only selected components (clients, groups/roles). It distinguishes from siblings like 'export_identity_provider_broker_config' but lacks specificity.

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 description provides no guidance on when to use this tool versus alternatives (e.g., get_realm, export_identity_provider_broker_config). It doesn't mention scenarios where partial export is appropriate or when to prefer other export tools. No context on prerequisites or limitations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/paoloamato2/keycloak-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server