Skip to main content
Glama
idoyudha

mcp-keycloak

by idoyudha
OverviewSchemaRelated ServersScoreDiscussions
Python
Remote

count_users

Retrieve the total number of users in a Keycloak realm to monitor user base size and manage access control.

Instructions

Count all users.

Args:
    realm: Target realm (uses default if not specified)

Returns:
    Number of users

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
realmNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • src/tools/user_tools.py:250-262 (handler)
    The main handler function for the 'count_users' tool. It is decorated with @mcp.tool(), which likely handles both registration and schema inference from the function signature and docstring. The function calls the Keycloak client's _make_request method to GET /users/count endpoint to retrieve the user count for the specified realm.
    @mcp.tool()
async def count_users(realm: Optional[str] = None) -> int:
    """
    Count all users.

    Args:
        realm: Target realm (uses default if not specified)

    Returns:
        Number of users
    """
    return await client._make_request("GET", "/users/count", realm=realm)

Tool Definition Quality

B3.2/5.0
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. It mentions the 'realm' parameter and return value, but doesn't disclose behavioral traits like whether this is a read-only operation, if it requires specific permissions, rate limits, or how it handles large datasets. The description is minimal and lacks crucial operational context.

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 extremely concise and well-structured with clear sections for 'Args' and 'Returns'. Every sentence earns its place, and there's no wasted text, making it easy to scan and understand quickly.

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 tool's low complexity (one optional parameter) and the presence of an output schema (which handles return values), the description is somewhat complete but lacks depth. It covers the basics but misses behavioral context like permissions or performance considerations, which would be helpful for an agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description adds meaningful context for the 'realm' parameter by explaining it's optional and defaults to a target realm, which isn't covered in the schema (0% coverage). This compensates well for the low schema coverage, though it could provide more details on realm format or examples.

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 clearly states the verb ('Count') and resource ('users'), making the purpose specific and understandable. However, it doesn't explicitly differentiate from sibling tools like 'list_users', which might provide more detailed user information rather than just a count.

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 such as 'list_users' or 'get_user'. It lacks context about scenarios where only a count is needed versus full user details, offering no explicit when/when-not or alternative recommendations.

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/idoyudha/mcp-keycloak'

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