Skip to main content
Glama
DiversioTeam

ClickUp MCP Server

by DiversioTeam

list_users

Retrieve all workspace members to manage team access and assign tasks in ClickUp project workflows.

Instructions

List all users in the workspace

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspace_idNoWorkspace ID (optional, uses default if not provided)

Implementation Reference

  • The core execution logic for the 'list_users' tool. Fetches workspace members from ClickUp API via client and returns formatted list.
    async def list_users(self, workspace_id: Optional[str] = None) -> Dict[str, Any]:
        """List all users in the workspace."""
        members = await self.client.get_workspace_members(workspace_id)
    
        return {
            "users": [
                {
                    "id": member.get("id"),
                    "username": member.get("username"),
                    "email": member.get("email"),
                    "initials": member.get("initials"),
                    "color": member.get("color"),
                    "profilePicture": member.get("profilePicture"),
                }
                for member in members
            ],
            "count": len(members),
        }
  • MCP Tool schema definition for 'list_users', specifying input parameters and description.
    Tool(
        name="list_users",
        description="List all users in the workspace",
        inputSchema={
            "type": "object",
            "properties": {
                "workspace_id": {
                    "type": "string",
                    "description": "Workspace ID (optional, uses default if not provided)",
                },
            },
        },
    ),
  • Registers the list_users method in the ClickUpTools class's internal tools dictionary for dynamic dispatching.
        # User management
        "list_users": self.list_users,
        "get_current_user": self.get_current_user,
        "find_user_by_name": self.find_user_by_name,
    }
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits such as whether this is a read-only operation, if it requires specific permissions, how results are returned (e.g., pagination, format), or any rate limits. This is inadequate for a tool with potential access control implications.

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 a single, efficient sentence that front-loads the core purpose without unnecessary words. It earns its place by clearly stating what the tool does, making it appropriately sized and structured.

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 annotations and output schema, the description is incomplete. It doesn't explain what 'list all users' entails—such as the return format, whether it includes inactive users, or any filtering capabilities. For a user-listing tool in a workspace context, more detail is needed to guide the agent effectively.

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?

The input schema has 100% description coverage, documenting the optional 'workspace_id' parameter. The description adds no additional parameter semantics beyond what's in the schema, so it meets the baseline of 3 without compensating value.

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 ('List') and resource ('all users in the workspace'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'find_user_by_name' or 'get_current_user', which would require explicit comparison to earn a 5.

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 like 'find_user_by_name' or 'get_current_user'. It lacks context about use cases, prerequisites, or exclusions, leaving the agent to infer usage from the name alone.

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/DiversioTeam/clickup-mcp'

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