clickup-automation
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseClickUp Automation via Rube MCP
通过Rube MCP实现ClickUp自动化
Automate ClickUp project management workflows including task creation and updates, workspace hierarchy navigation, comments, and team member management through Composio's ClickUp toolkit.
Toolkit docs: composio.dev/toolkits/clickup
通过Composio的ClickUp工具包,自动化ClickUp项目管理工作流,包括任务创建与更新、工作区层级导航、评论以及团队成员管理。
Prerequisites
前提条件
- Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
- Active ClickUp connection via with toolkit
RUBE_MANAGE_CONNECTIONSclickup - Always call first to get current tool schemas
RUBE_SEARCH_TOOLS
- 必须已连接Rube MCP(需具备RUBE_SEARCH_TOOLS权限)
- 通过并使用
RUBE_MANAGE_CONNECTIONS工具包完成ClickUp的激活连接clickup - 请始终先调用以获取最新的工具架构
RUBE_SEARCH_TOOLS
Setup
设置步骤
Get Rube MCP: Add as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.
https://rube.app/mcp- Verify Rube MCP is available by confirming responds
RUBE_SEARCH_TOOLS - Call with toolkit
RUBE_MANAGE_CONNECTIONSclickup - If connection is not ACTIVE, follow the returned auth link to complete ClickUp OAuth
- Confirm connection status shows ACTIVE before running any workflows
获取Rube MCP:在客户端配置中添加作为MCP服务器。无需API密钥 —— 只需添加端点即可使用。
https://rube.app/mcp- 通过确认能正常响应,验证Rube MCP是否可用
RUBE_SEARCH_TOOLS - 调用并指定工具包为
RUBE_MANAGE_CONNECTIONSclickup - 如果连接未处于激活状态,请按照返回的授权链接完成ClickUp OAuth认证
- 在运行任何工作流之前,确认连接状态显示为ACTIVE
Core Workflows
核心工作流
1. Create and Manage Tasks
1. 创建与管理任务
When to use: User wants to create tasks, subtasks, update task properties, or list tasks in a ClickUp list.
Tool sequence:
- - Get workspace/team IDs [Prerequisite]
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - - List spaces in the workspace [Prerequisite]
CLICKUP_GET_SPACES - - List folders in a space [Prerequisite]
CLICKUP_GET_FOLDERS - - Get lists not inside folders [Optional]
CLICKUP_GET_FOLDERLESS_LISTS - - Validate list and check available statuses [Prerequisite]
CLICKUP_GET_LIST - - Create a task in the target list [Required]
CLICKUP_CREATE_TASK - (with
CLICKUP_CREATE_TASK) - Create subtask under a parent task [Optional]parent - - Modify task status, assignees, dates, priority [Optional]
CLICKUP_UPDATE_TASK - - Retrieve full task details [Optional]
CLICKUP_GET_TASK - - List all tasks in a list with filters [Optional]
CLICKUP_GET_TASKS - - Permanently remove a task [Optional]
CLICKUP_DELETE_TASK
Key parameters for CLICKUP_CREATE_TASK:
- : Target list ID (integer, required)
list_id - : Task name (string, required)
name - : Detailed task description
description - : Must exactly match (case-sensitive) a status name configured in the target list
status - : 1 (Urgent), 2 (High), 3 (Normal), 4 (Low)
priority - : Array of user IDs (integers)
assignees - : Unix timestamp in milliseconds
due_date - : Parent task ID string for creating subtasks
parent - : Array of tag name strings
tags - : Estimated time in milliseconds
time_estimate
Pitfalls:
- is case-sensitive and must match an existing status in the list; use
statusto check available statusesCLICKUP_GET_LIST - and
due_dateare Unix timestamps in milliseconds, not secondsstart_date - Subtask must be a task (not another subtask) in the same list
parent - triggers watcher notifications; set to false for bulk operations
notify_all - Retries can create duplicates; track created task IDs to avoid re-creation
- for milestones (ID 1) is subject to workspace plan quotas
custom_item_id
适用场景:用户需要在ClickUp列表中创建任务、子任务、更新任务属性或列出任务。
工具执行顺序:
- - 获取工作区/团队ID [前提步骤]
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - - 列出工作区内的空间 [前提步骤]
CLICKUP_GET_SPACES - - 列出空间内的文件夹 [前提步骤]
CLICKUP_GET_FOLDERS - - 获取未包含在文件夹中的列表 [可选]
CLICKUP_GET_FOLDERLESS_LISTS - - 验证列表并查看可用状态 [前提步骤]
CLICKUP_GET_LIST - - 在目标列表中创建任务 [必需]
CLICKUP_CREATE_TASK - (传入
CLICKUP_CREATE_TASK参数)- 在父任务下创建子任务 [可选]parent - - 修改任务状态、经办人、日期、优先级 [可选]
CLICKUP_UPDATE_TASK - - 获取完整的任务详情 [可选]
CLICKUP_GET_TASK - - 按筛选条件列出列表中的所有任务 [可选]
CLICKUP_GET_TASKS - - 永久删除任务 [可选]
CLICKUP_DELETE_TASK
CLICKUP_CREATE_TASK的关键参数:
- : 目标列表ID(整数,必填)
list_id - : 任务名称(字符串,必填)
name - : 详细的任务描述
description - : 必须与目标列表中配置的状态名称完全匹配(区分大小写)
status - : 1(紧急)、2(高)、3(普通)、4(低)
priority - : 用户ID数组(整数)
assignees - : 毫秒级Unix时间戳
due_date - : 用于创建子任务的父任务ID字符串
parent - : 标签名称字符串数组
tags - : 预估耗时(毫秒)
time_estimate
注意事项:
- 区分大小写,必须与列表中已存在的状态匹配;请使用
status查看可用状态CLICKUP_GET_LIST - 和
due_date为毫秒级Unix时间戳,而非秒级start_date - 子任务的必须是同一列表中的任务(不能是其他子任务)
parent - 会触发关注者通知;批量操作时请设置为false
notify_all - 重试可能会创建重复任务;请跟踪已创建的任务ID以避免重复创建
- 里程碑的(ID为1)受工作区计划配额限制
custom_item_id
2. Navigate Workspace Hierarchy
2. 导航工作区层级
When to use: User wants to browse or manage the ClickUp workspace structure (Workspaces > Spaces > Folders > Lists).
Tool sequence:
- - List all accessible workspaces [Required]
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - - List spaces within a workspace [Required]
CLICKUP_GET_SPACES - - Get details for a specific space [Optional]
CLICKUP_GET_SPACE - - List folders in a space [Required]
CLICKUP_GET_FOLDERS - - Get details for a specific folder [Optional]
CLICKUP_GET_FOLDER - - Create a new folder in a space [Optional]
CLICKUP_CREATE_FOLDER - - List lists not inside any folder [Required]
CLICKUP_GET_FOLDERLESS_LISTS - - Get list details including statuses and custom fields [Optional]
CLICKUP_GET_LIST
Key parameters:
- : Workspace ID from GET_AUTHORIZED_TEAMS_WORKSPACES (required for spaces)
team_id - : Space ID (required for folders and folderless lists)
space_id - : Folder ID (required for GET_FOLDER)
folder_id - : List ID (required for GET_LIST)
list_id - : Boolean filter for archived/active items
archived
Pitfalls:
- ClickUp hierarchy is: Workspace (Team) > Space > Folder > List > Task
- Lists can exist directly under Spaces (folderless) or inside Folders
- Must use to find lists not inside folders;
CLICKUP_GET_FOLDERLESS_LISTSonly returns foldersCLICKUP_GET_FOLDERS - in ClickUp API refers to the Workspace ID, not a user group
team_id
适用场景:用户需要浏览或管理ClickUp工作区结构(工作区 > 空间 > 文件夹 > 列表)。
工具执行顺序:
- - 列出所有可访问的工作区 [必需]
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - - 列出工作区内的空间 [必需]
CLICKUP_GET_SPACES - - 获取特定空间的详情 [可选]
CLICKUP_GET_SPACE - - 列出空间内的文件夹 [必需]
CLICKUP_GET_FOLDERS - - 获取特定文件夹的详情 [可选]
CLICKUP_GET_FOLDER - - 在空间中创建新文件夹 [可选]
CLICKUP_CREATE_FOLDER - - 列出未包含在任何文件夹中的列表 [必需]
CLICKUP_GET_FOLDERLESS_LISTS - - 获取列表详情,包括状态和自定义字段 [可选]
CLICKUP_GET_LIST
关键参数:
- : 来自GET_AUTHORIZED_TEAMS_WORKSPACES的工作区ID(获取空间时必填)
team_id - : 空间ID(获取文件夹和无文件夹列表时必填)
space_id - : 文件夹ID(获取文件夹详情时必填)
folder_id - : 列表ID(获取列表详情时必填)
list_id - : 用于筛选已归档/活跃项目的布尔值
archived
注意事项:
- ClickUp的层级结构为:工作区(团队)> 空间 > 文件夹 > 列表 > 任务
- 列表可以直接存在于空间下(无文件夹)或在文件夹内
- 必须使用查找未在文件夹中的列表;
CLICKUP_GET_FOLDERLESS_LISTS仅返回文件夹CLICKUP_GET_FOLDERS - ClickUp API中的指的是工作区ID,而非用户组
team_id
3. Add Comments to Tasks
3. 为任务添加评论
When to use: User wants to add comments, review existing comments, or manage comment threads on tasks.
Tool sequence:
- - Verify task exists and get task_id [Prerequisite]
CLICKUP_GET_TASK - - Add a new comment to the task [Required]
CLICKUP_CREATE_TASK_COMMENT - - List existing comments on the task [Optional]
CLICKUP_GET_TASK_COMMENTS - - Edit comment text, assignee, or resolution status [Optional]
CLICKUP_UPDATE_COMMENT
Key parameters for CLICKUP_CREATE_TASK_COMMENT:
- : Task ID string (required)
task_id - : Comment content with ClickUp formatting support (required)
comment_text - : User ID to assign the comment to (required)
assignee - : true/false for watcher notifications (required)
notify_all
Key parameters for CLICKUP_GET_TASK_COMMENTS:
- : Task ID string (required)
task_id - /
start: Pagination for older comments (max 25 per page)start_id
Pitfalls:
- requires all four fields:
CLICKUP_CREATE_TASK_COMMENT,task_id,comment_text, andassigneenotify_all - on a comment assigns the comment (not the task) to that user
assignee - Comments are paginated at 25 per page; use (Unix ms) and
startfor older pagesstart_id - requires all four fields:
CLICKUP_UPDATE_COMMENT,comment_id,comment_text,assigneeresolved
适用场景:用户需要为任务添加评论、查看现有评论或管理任务的评论线程。
工具执行顺序:
- - 验证任务存在并获取task_id [前提步骤]
CLICKUP_GET_TASK - - 为任务添加新评论 [必需]
CLICKUP_CREATE_TASK_COMMENT - - 列出任务的现有评论 [可选]
CLICKUP_GET_TASK_COMMENTS - - 编辑评论内容、经办人或解决状态 [可选]
CLICKUP_UPDATE_COMMENT
CLICKUP_CREATE_TASK_COMMENT的关键参数:
- : 任务ID字符串(必填)
task_id - : 支持ClickUp格式的评论内容(必填)
comment_text - : 要分配评论的用户ID(必填)
assignee - : 是否通知所有关注者的布尔值(必填)
notify_all
CLICKUP_GET_TASK_COMMENTS的关键参数:
- : 任务ID字符串(必填)
task_id - /
start: 旧评论的分页参数(每页最多25条)start_id
注意事项:
- 需要四个必填字段:
CLICKUP_CREATE_TASK_COMMENT、task_id、comment_text和assigneenotify_all - 评论上的是将评论(而非任务)分配给该用户
assignee - 评论按每页25条分页;使用(毫秒级Unix时间戳)和
start获取旧页面的评论start_id - 需要四个必填字段:
CLICKUP_UPDATE_COMMENT、comment_id、comment_text、assigneeresolved
4. Manage Team Members and Assignments
4. 管理团队成员与分配
When to use: User wants to view workspace members, check seat utilization, or look up user details.
Tool sequence:
- - List workspaces and get team_id [Required]
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - - Check seat utilization (members vs guests) [Required]
CLICKUP_GET_WORKSPACE_SEATS - - List user groups within the workspace [Optional]
CLICKUP_GET_TEAMS - - Get details for a specific user (Enterprise only) [Optional]
CLICKUP_GET_USER - - List custom permission roles [Optional]
CLICKUP_GET_CUSTOM_ROLES
Key parameters:
- : Workspace ID (required for all team operations)
team_id - : Specific user ID for GET_USER
user_id - : Comma-separated group IDs to filter teams
group_ids
Pitfalls:
- returns seat counts, not member details; distinguish members from guests
CLICKUP_GET_WORKSPACE_SEATS - returns user groups, not workspace members; empty groups does not mean no members
CLICKUP_GET_TEAMS - is only available on ClickUp Enterprise Plan
CLICKUP_GET_USER - Must repeat workspace seat queries for each workspace in multi-workspace setups
适用场景:用户需要查看工作区成员、检查席位使用情况或查找用户详情。
工具执行顺序:
- - 列出工作区并获取team_id [必需]
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - - 检查席位使用情况(成员与访客)[必需]
CLICKUP_GET_WORKSPACE_SEATS - - 列出工作区内的用户组 [可选]
CLICKUP_GET_TEAMS - - 获取特定用户的详情(仅企业版可用)[可选]
CLICKUP_GET_USER - - 列出自定义权限角色 [可选]
CLICKUP_GET_CUSTOM_ROLES
关键参数:
- : 工作区ID(所有团队操作必填)
team_id - : GET_USER所需的特定用户ID
user_id - : 用于筛选团队的逗号分隔组ID
group_ids
注意事项:
- 返回席位数量,而非成员详情;请区分成员与访客
CLICKUP_GET_WORKSPACE_SEATS - 返回用户组,而非工作区成员;空组不代表没有成员
CLICKUP_GET_TEAMS - 仅在ClickUp企业版计划中可用
CLICKUP_GET_USER - 在多工作区设置中,必须为每个工作区重复查询工作区席位
5. Filter and Query Tasks
5. 筛选与查询任务
When to use: User wants to find tasks with specific filters (status, assignee, dates, tags, custom fields).
Tool sequence:
- - Filter tasks in a list with multiple criteria [Required]
CLICKUP_GET_TASKS - - Get full details for individual tasks [Optional]
CLICKUP_GET_TASK
Key parameters for CLICKUP_GET_TASKS:
- : List ID (integer, required)
list_id - : Array of status strings to filter by
statuses - : Array of user ID strings
assignees - : Array of tag name strings
tags - /
due_date_gt: Unix timestamp in ms for date rangedue_date_lt - : Boolean to include closed tasks
include_closed - : Boolean to include subtasks
subtasks - : "id", "created", "updated", or "due_date"
order_by - : Page number starting at 0 (max 100 tasks per page)
page
Pitfalls:
- Only tasks whose home list matches are returned; tasks in sublists are not included
list_id - Date filters use Unix timestamps in milliseconds
- Status strings must match exactly; use URL encoding for spaces (e.g., "to%20do")
- Page numbering starts at 0; each page returns up to 100 tasks
- filter accepts an array of JSON strings, not objects
custom_fields
适用场景:用户需要查找符合特定筛选条件的任务(状态、经办人、日期、标签、自定义字段)。
工具执行顺序:
- - 按多个条件筛选列表中的任务 [必需]
CLICKUP_GET_TASKS - - 获取单个任务的完整详情 [可选]
CLICKUP_GET_TASK
CLICKUP_GET_TASKS的关键参数:
- : 列表ID(整数,必填)
list_id - : 用于筛选的状态字符串数组
statuses - : 用户ID字符串数组
assignees - : 标签名称字符串数组
tags - /
due_date_gt: 日期范围的毫秒级Unix时间戳due_date_lt - : 是否包含已关闭任务的布尔值
include_closed - : 是否包含子任务的布尔值
subtasks - : 排序依据,可选"id"、"created"、"updated"或"due_date"
order_by - : 页码,从0开始(每页最多100条任务)
page
注意事项:
- 仅返回主列表为的任务;子列表中的任务不包含在内
list_id - 日期筛选使用毫秒级Unix时间戳
- 状态字符串必须完全匹配;含空格的状态需使用URL编码(例如"to%20do")
- 页码从0开始;每页最多返回100条任务
- 筛选条件接受JSON字符串数组,而非对象
custom_fields
Common Patterns
通用模式
ID Resolution
ID解析
Always resolve names to IDs through the hierarchy:
- Workspace name -> team_id: and match by name
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - Space name -> space_id: with
CLICKUP_GET_SPACESteam_id - Folder name -> folder_id: with
CLICKUP_GET_FOLDERSspace_id - List name -> list_id: Navigate folders or use
CLICKUP_GET_FOLDERLESS_LISTS - Task name -> task_id: with
CLICKUP_GET_TASKSand match by namelist_id
请始终通过层级结构将名称解析为ID:
- 工作区名称 -> team_id: 使用并按名称匹配
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES - 空间名称 -> space_id: 使用带参数的
team_idCLICKUP_GET_SPACES - 文件夹名称 -> folder_id: 使用带参数的
space_idCLICKUP_GET_FOLDERS - 列表名称 -> list_id: 遍历文件夹或使用
CLICKUP_GET_FOLDERLESS_LISTS - 任务名称 -> task_id: 使用带参数的
list_id并按名称匹配CLICKUP_GET_TASKS
Pagination
分页
- : Page-based with
CLICKUP_GET_TASKSstarting at 0, max 100 tasks per pagepage - : Uses
CLICKUP_GET_TASK_COMMENTS(Unix ms) andstartfor cursor-based paging, max 25 per pagestart_id - Continue fetching until response returns fewer items than the page size
- : 基于页码的分页,
CLICKUP_GET_TASKS从0开始,每页最多100条任务page - : 使用
CLICKUP_GET_TASK_COMMENTS(毫秒级Unix时间戳)和start进行基于游标分页,每页最多25条start_id - 持续获取直到返回的结果数量小于每页最大数量
Known Pitfalls
已知注意事项
ID Formats
ID格式
- Workspace/Team IDs are large integers
- Space, folder, and list IDs are integers
- Task IDs are alphanumeric strings (e.g., "9hz", "abc123")
- User IDs are integers
- Comment IDs are integers
- 工作区/团队ID为大整数
- 空间、文件夹和列表ID为整数
- 任务ID为字母数字字符串(例如"9hz"、"abc123")
- 用户ID为整数
- 评论ID为整数
Rate Limits
速率限制
- ClickUp enforces rate limits; bulk task creation can trigger 429 responses
- Honor header when present
Retry-After - Set for bulk operations to reduce notification load
notify_all=false
- ClickUp设有速率限制;批量创建任务可能会触发429响应
- 若存在响应头,请遵循该指示进行重试
Retry-After - 批量操作时设置以减少通知负载
notify_all=false
Parameter Quirks
参数特殊点
- in the API means Workspace ID, not a user group
team_id - on tasks is case-sensitive and list-specific
status - Dates are Unix timestamps in milliseconds (multiply seconds by 1000)
- is an integer 1-4 (1=Urgent, 4=Low), not a string
priority - marks
CLICKUP_CREATE_TASK_COMMENTandassigneeas requirednotify_all - To clear a task description, pass a single space to
" "CLICKUP_UPDATE_TASK
- API中的指工作区ID,而非用户组
team_id - 任务的区分大小写且与列表相关
status - 日期为毫秒级Unix时间戳(需将秒数乘以1000)
- 为1-4的整数(1=紧急,4=低),而非字符串
priority - 要求
CLICKUP_CREATE_TASK_COMMENT和assignee为必填字段notify_all - 若要清除任务描述,请在中传入单个空格
CLICKUP_UPDATE_TASK" "
Hierarchy Rules
层级规则
- Subtask parent must not itself be a subtask
- Subtask parent must be in the same list
- Lists can be folderless (directly in a Space) or inside a Folder
- Subitem boards are not supported by CLICKUP_CREATE_TASK
- 子任务的父任务不能是其他子任务
- 子任务的父任务必须在同一列表中
- 列表可以是无文件夹的(直接在空间下)或在文件夹内
- CLICKUP_CREATE_TASK不支持子项看板
Quick Reference
快速参考
| Task | Tool Slug | Key Params |
|---|---|---|
| List workspaces | | (none) |
| List spaces | | |
| Get space details | | |
| List folders | | |
| Get folder details | | |
| Create folder | | |
| Folderless lists | | |
| Get list details | | |
| Create task | | |
| Update task | | |
| Get task | | |
| List tasks | | |
| Delete task | | |
| Add comment | | |
| List comments | | |
| Update comment | | |
| Workspace seats | | |
| List user groups | | |
| Get user details | | |
| Custom roles | | |
Powered by Composio
| 操作 | 工具标识 | 关键参数 |
|---|---|---|
| 列出工作区 | | 无 |
| 列出空间 | | |
| 获取空间详情 | | |
| 列出文件夹 | | |
| 获取文件夹详情 | | |
| 创建文件夹 | | |
| 无文件夹列表 | | |
| 获取列表详情 | | |
| 创建任务 | | |
| 更新任务 | | |
| 获取任务详情 | | |
| 列出任务 | | |
| 删除任务 | | |
| 添加评论 | | |
| 列出评论 | | |
| 更新评论 | | |
| 工作区席位 | | |
| 列出用户组 | | |
| 获取用户详情 | | |
| 自定义角色 | | |
由 Composio 提供支持