Skip to main content
Glama
jamesbrink

MCP Server for Coroot

list_users

Retrieve all system users with their roles and permissions for administrative oversight and access management.

Instructions

List all users in the system (admin only).

Returns all users with their roles and permissions. Requires admin privileges.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler implementation for the list_users MCP tool. Calls CorootClient.list_users() and formats the response with success wrapper.
    @handle_errors
    async def list_users_impl() -> dict[str, Any]:
        """List all users."""
        users = await get_client().list_users()
        return {
            "success": True,
            "users": users,
        }
  • MCP tool registration for 'list_users' using FastMCP @mcp.tool() decorator. Includes tool description docstring and delegates to implementation.
    @mcp.tool()
    async def list_users() -> dict[str, Any]:
        """List all users in the system (admin only).
    
        Returns all users with their roles and permissions.
        Requires admin privileges.
        """
        return await list_users_impl()  # type: ignore[no-any-return]
  • CorootClient helper method that performs the actual API call to GET /api/users to retrieve user list.
    async def list_users(self) -> dict[str, Any]:
        """List all users (admin only).
    
        Returns:
            List of all users.
        """
        response = await self._request("GET", "/api/users")
        data: dict[str, Any] = response.json()
        return data
Behavior3/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 discloses the admin requirement and return data, but lacks details on behavioral traits like pagination, rate limits, or error handling. It doesn't contradict any annotations.

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 front-loaded with the core purpose, followed by return details and prerequisites. It's efficient with three sentences, though the second sentence could be integrated more tightly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 0 parameters, no annotations, and an output schema (which handles return values), the description is reasonably complete. It covers purpose, admin requirement, and return data, but could add more behavioral context like pagination or scope limitations.

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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add param info, which is appropriate, but could mention if there are implicit filters (e.g., by status). Baseline is 4 for 0 params.

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 ('List') and resource ('all users in the system'), and mentions what data is returned ('roles and permissions'). It doesn't explicitly differentiate from sibling tools like 'get_current_user' or 'get_roles', but the scope is clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use it ('admin only' and 'Requires admin privileges'), which helps distinguish it from non-admin tools. However, it doesn't explicitly mention when not to use it or name alternatives like 'get_current_user' for non-admin access.

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/jamesbrink/mcp-coroot'

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