Skip to main content
Glama
idoyudha

mcp-keycloak

by idoyudha

get_user_sessions

Retrieve active user sessions from Keycloak identity management by providing a user ID and optional realm to monitor authentication activity.

Instructions

Get active sessions for a user.

Args:
    user_id: The user's ID
    realm: Target realm (uses default if not specified)

Returns:
    List of active sessions

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_idYes
realmNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function for the 'get_user_sessions' tool. It is decorated with @mcp.tool() which also serves as registration. Retrieves active sessions for the specified user from the Keycloak API via the KeycloakClient.
    @mcp.tool()
    async def get_user_sessions(
        user_id: str, realm: Optional[str] = None
    ) -> List[Dict[str, Any]]:
        """
        Get active sessions for a user.
    
        Args:
            user_id: The user's ID
            realm: Target realm (uses default if not specified)
    
        Returns:
            List of active sessions
        """
        return await client._make_request("GET", f"/users/{user_id}/sessions", realm=realm)
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 behavioral disclosure. It states the tool retrieves active sessions but doesn't describe what constitutes an 'active session', whether the data is real-time or cached, any rate limits, authentication requirements, or error handling. This is inadequate for a tool that likely involves sensitive session data.

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 well-structured and front-loaded with the core purpose, followed by clear sections for Args and Returns. Every sentence earns its place without redundancy, making it efficient and easy to parse for an AI agent.

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 moderate complexity (2 parameters, no annotations, but has an output schema), the description is partially complete. It covers the purpose and parameters adequately, but lacks behavioral details like security implications or performance characteristics. The output schema existence reduces the need to explain return values, but more context on usage and constraints is needed.

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 both parameters: 'user_id' is explained as 'The user's ID', and 'realm' is clarified with 'Target realm (uses default if not specified)'. This compensates for the 0% schema description coverage by providing essential usage semantics beyond the bare schema, though it could benefit from examples or format details.

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 tool's purpose with a specific verb ('Get') and resource ('active sessions for a user'), making it immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'remove_all_user_sessions' or 'logout_user', which also deal with user sessions but perform different operations.

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. It doesn't mention prerequisites, such as needing user permissions or authentication, or compare it to related tools like 'get_user' or 'list_users' for user information retrieval. This leaves the agent without context for tool selection.

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