Skip to main content
Glama
DiversioTeam

ClickUp MCP Server

by DiversioTeam

find_list_by_name

Locate ClickUp lists by name to access tasks and manage projects. Specify the list name and optional space ID for targeted search.

Instructions

Find a list by name

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesList name to search for
space_idNoSpace ID to search in

Implementation Reference

  • The primary handler function for the MCP tool 'find_list_by_name'. It calls the ClickUpClient's find_list_by_name method and formats the result into a dictionary response.
    async def find_list_by_name(self, name: str, space_id: Optional[str] = None) -> Dict[str, Any]:
        """Find list by name."""
        lst = await self.client.find_list_by_name(name, space_id)
    
        if not lst:
            return {"error": f"List '{name}' not found"}
    
        return {
            "id": lst.id,
            "name": lst.name,
            "space": lst.space.get("name", "Unknown"),
            "folder": lst.folder.get("name") if lst.folder else None,
            "found": True,
        }
  • The input schema definition for the 'find_list_by_name' tool, specifying parameters 'name' (required) and optional 'space_id'.
    Tool(
        name="find_list_by_name",
        description="Find a list by name",
        inputSchema={
            "type": "object",
            "properties": {
                "name": {"type": "string", "description": "List name to search for"},
                "space_id": {"type": "string", "description": "Space ID to search in"},
            },
            "required": ["name"],
        },
    ),
  • Registration of the 'find_list_by_name' handler in the _tools dictionary within ClickUpTools class, mapping tool name to its implementation method.
    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,
    }
  • Supporting helper method in ClickUpClient that performs the actual search for a list by name across space lists and subfolders, used by the tool handler.
    async def find_list_by_name(
        self,
        name: str,
        space_id: Optional[str] = None,
    ) -> Optional[ClickUpList]:
        """Find a list by name in a space."""
        if not space_id:
            # Search in all spaces if not specified
            spaces = await self.get_spaces()
            for space in spaces:
                result = await self.find_list_by_name(name, space.id)
                if result:
                    return result
            return None
    
        # Get all lists in the space
        lists = await self.get_lists(space_id=space_id)
    
        # Also check folders
        folders = await self.get_folders(space_id)
        for folder in folders:
            folder_lists = await self.get_lists(folder_id=folder.id)
            lists.extend(folder_lists)
    
        # Find by name (case-insensitive)
        name_lower = name.lower()
        for lst in lists:
            if lst.name.lower() == name_lower:
                return lst
    
        return None
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. 'Find a list by name' implies a read-only search operation, but it does not specify whether it returns a single list or multiple matches, error handling for non-existent lists, authentication requirements, or rate limits. This leaves significant gaps in understanding the tool's behavior beyond basic intent.

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 'Find a list by name' is extremely concise—a single, front-loaded sentence that directly conveys the core action without unnecessary words. It efficiently uses minimal text to state the purpose, earning its place without waste.

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 tool's complexity (a search operation with 2 parameters), lack of annotations, and no output schema, the description is incomplete. It does not explain what is returned (e.g., list object, error messages), search semantics, or how it differs from sibling tools. This leaves the agent with insufficient context to use the tool effectively beyond basic parameter input.

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, with clear parameter descriptions ('List name to search for', 'Space ID to search in'). The tool description does not add any additional semantic context beyond what the schema provides, such as search behavior or format details. With high schema coverage, the baseline score of 3 is appropriate, as the description does not compensate but also does not detract.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Find a list by name' clearly states the verb ('find') and resource ('list'), making the purpose understandable. However, it lacks specificity about what 'find' entails (e.g., exact match, partial search) and does not distinguish it from sibling tools like 'list_lists' or 'find_user_by_name', which follow a similar pattern. This results in a vague but functional purpose statement.

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_lists' (which might list all lists without filtering) or other search-related tools. It does not mention prerequisites, exclusions, or contextual cues for selection, leaving the agent to infer usage based on the tool 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