Skip to main content
Glama

skycloak_list_realm_users

Read-only

List users in a Keycloak realm by cluster ID and realm name to review identities. Use it to retrieve realm user accounts for auditing or management.

Instructions

List the users in 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": {
      "cluster_id": "<cluster_id>",
      "realm": "<realm>"
    },
    "name": "skycloak_list_realm_users"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
countYes
usersYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false and idempotentHint=false, so the safety profile is covered. The description adds nothing further: no pagination behavior, no result-set size limits, no indication of what happens for an unknown realm. With annotations doing the work, this is a minimal contribution.

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 short sentence with zero filler and the resource front-loaded after the verb. It is efficient, though its brevity comes at the cost of any operational detail.

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 and the input schema is fully described, so return shape and parameters are covered elsewhere. For a list operation, though, the absence of any pagination or result-size guidance leaves a meaningful gap.

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 both cluster_id and realm documented in the schema itself. The description adds no meaning about how realm scoping or cluster selection affects results, so the 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 (list) and resource (users in a realm), so the operation is unambiguous. It does not distinguish itself from near siblings such as skycloak_list_realm_group_members or skycloak_get_realm_user, leaving the agent to infer scope from names alone.

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?

There is no when-to-use or when-not-to-use guidance, and no named alternative for filtering by group or fetching a single user. Usage is only implied by the verb 'list'.

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