Skip to main content
Glama
DiversioTeam

ClickUp MCP Server

by DiversioTeam

find_user_by_name

Locate ClickUp users by entering their name or email address to identify team members for task assignments and collaboration.

Instructions

Find a user by name or email

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesName or email to search for
workspace_idNoWorkspace ID (optional, uses default if not provided)

Implementation Reference

  • The main handler function implementing the find_user_by_name tool. It fetches workspace members via the client and searches for matches by name or email (case-insensitive).
    async def find_user_by_name(
        self, name: str, workspace_id: Optional[str] = None
    ) -> Dict[str, Any]:
        """Find a user by name or email."""
        members = await self.client.get_workspace_members(workspace_id)
    
        # Search by username or email (case-insensitive)
        name_lower = name.lower()
        matches = []
    
        for member in members:
            username = member.get("username", "").lower()
            email = member.get("email", "").lower()
    
            if name_lower in username or name_lower in email:
                matches.append(
                    {
                        "id": member.get("id"),
                        "username": member.get("username"),
                        "email": member.get("email"),
                        "initials": member.get("initials"),
                        "color": member.get("color"),
                        "profilePicture": member.get("profilePicture"),
                    }
                )
    
        if not matches:
            return {"error": f"No user found matching '{name}'", "matches": []}
    
        return {
            "matches": matches,
            "count": len(matches),
            "found": True,
        }
  • The input schema and description for the find_user_by_name tool defined in get_tool_definitions().
    Tool(
        name="find_user_by_name",
        description="Find a user by name or email",
        inputSchema={
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "Name or email to search for",
                },
                "workspace_id": {
                    "type": "string",
                    "description": "Workspace ID (optional, uses default if not provided)",
                },
            },
            "required": ["name"],
        },
    ),
  • Registration of the find_user_by_name handler in the ClickUpTools class's _tools dictionary during __init__.
    self._tools: Dict[str, Callable] = {
        "create_task": self.create_task,
        "get_task": self.get_task,
        "update_task": self.update_task,
        "delete_task": self.delete_task,
        "list_tasks": self.list_tasks,
        "search_tasks": self.search_tasks,
        "get_subtasks": self.get_subtasks,
        "get_task_comments": self.get_task_comments,
        "create_task_comment": self.create_task_comment,
        "get_task_status": self.get_task_status,
        "update_task_status": self.update_task_status,
        "get_assignees": self.get_assignees,
        "assign_task": self.assign_task,
        "list_spaces": self.list_spaces,
        "list_folders": self.list_folders,
        "list_lists": self.list_lists,
        "find_list_by_name": self.find_list_by_name,
        # Bulk operations
        "bulk_update_tasks": self.bulk_update_tasks,
        "bulk_move_tasks": self.bulk_move_tasks,
        # Time tracking
        "get_time_tracked": self.get_time_tracked,
        "log_time": self.log_time,
        # Templates
        "create_task_from_template": self.create_task_from_template,
        "create_task_chain": self.create_task_chain,
        # Analytics
        "get_team_workload": self.get_team_workload,
        "get_task_analytics": self.get_task_analytics,
        # User management
        "list_users": self.list_users,
        "get_current_user": self.get_current_user,
        "find_user_by_name": self.find_user_by_name,
    }
  • MCP server registration point where list_tools handler returns tool definitions including find_user_by_name.
    @self.server.list_tools()
    async def list_tools() -> List[Tool]:
        """List all available tools."""
        return self.tools.get_tool_definitions()
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's function but doesn't cover critical aspects like whether it's read-only, its response format, error handling, or performance characteristics (e.g., search precision). This is inadequate for a tool with no annotation support.

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 with zero waste. It's front-loaded with the core purpose and appropriately sized for the tool's complexity, earning full marks for conciseness.

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 the tool returns (e.g., user object, list, or error), search behavior (e.g., exact match, partial), or usage constraints. For a query tool with no structured support, this leaves significant gaps.

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%, so the schema already documents both parameters thoroughly. The description adds no additional meaning beyond what's in the schema, such as search behavior or format details. Baseline 3 is appropriate when the schema does the heavy lifting.

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 ('Find') and resource ('user'), and specifies the search criteria ('by name or email'). However, it doesn't differentiate from sibling tools like 'list_users' or 'get_current_user', which prevents a score of 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 'list_users' or 'get_current_user'. It lacks context about use cases, exclusions, or prerequisites, leaving the agent with minimal direction.

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