ClickUp API服务器

为ClickUp API v2提供的全面模型上下文协议(MCP)服务器,覆盖所有可用端点。

  • by Yes-Gaming
  • Python
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 Yes-Gaming/clickup-full-api-mcp

使用说明

点击MCP服务器

用于ClickUp API v2的全面模型上下文协议(MCP)服务器,提供所有可用端点的全面覆盖。

特性

  • API全面覆盖:120多个工具,涵盖所有ClickUp API v2端点
  • 类型安全:完整的类型提示和Pydantic验证
  • 异步:基于async/await构建,实现高效运行
  • 没有硬编码的秘密:通过环境变量的API令牌

安装

# Using pip
pip install clickup-mcp

# From source
git clone https://github.com/Yes-Gaming/clickup-mcp.git
cd clickup-mcp
pip install -e .

配置

将您的ClickUp API令牌设置为环境变量:

export CLICKUP_API_TOKEN="pk_your_token_here"

您可以从ClickUp设置>应用程序>API令牌获取您的个人API令牌。

Claude桌面配置

添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "clickup": {
      "command": "clickup-mcp",
      "env": {
        "CLICKUP_API_TOKEN": "pk_your_token_here"
      }
    }
  }
}

或者使用uvx:

{
  "mcpServers": {
    "clickup": {
      "command": "uvx",
      "args": ["clickup-mcp"],
      "env": {
        "CLICKUP_API_TOKEN": "pk_your_token_here"
      }
    }
  }
}

可用工具(120+)

授权(1)

工具 说明
get_authorized_user 获取经过身份验证的用户信息

工作区(3)

工具 说明
get_workspaces 获取所有工作区
get_workspace_seats 获取工作区座位信息
get_workspace_plan 获取工作空间计划信息

空间(5)

工具 说明
get_spaces 列出工作区中的空间
create_space 创建空间
get_space 获取空间详细信息
update_space 更新空间
delete_space 删除空格

文件夹(5)

工具 说明
get_folders 列出空间中的文件夹
create_folder 创建文件夹
get_folder 获取文件夹详细信息
update_folder 更新文件夹
delete_folder 删除文件夹

列表(10)

工具 说明
get_lists 列出文件夹中的列表
create_list 在文件夹中创建列表
get_folderless_lists 获取不在文件夹中的列表
create_folderless_list 在空间中创建列表
get_list 获取列表详细信息
update_list 更新列表
delete_list 删除列表
add_task_to_list 将任务添加到列表
remove_task_from_list 从列表中删除任务

任务(11)

工具 说明
get_tasks 在列表中获取任务
create_task 创建任务
get_task 获取任务详细信息
update_task 更新任务
delete_task 删除任务
get_filtered_team_tasks 跨工作区筛选任务
get_task_time_in_status 在每个状态中获取时间
get_bulk_tasks_time_in_status 批量时间处于状态
create_task_from_template 从模板创建

任务清单(6)

工具 说明
create_checklist 创建任务检查表
update_checklist 更新检查表
delete_checklist 删除检查表
create_checklist_item 添加检查表项
update_checklist_item 更新项目(标记完成等)
delete_checklist_item 删除项目

任务关系(4)

工具 说明
add_dependency 添加任务依赖关系
delete_dependency 删除依赖关系
add_task_link 链接两个任务
delete_task_link 取消链接任务

评论(10)

工具 说明
get_task_comments 获取任务注释
create_task_comment 添加任务注释
get_list_comments 获取列表评论
create_list_comment 添加列表注释
get_chat_view_comments 获取聊天视图评论
create_chat_view_comment 添加聊天视图评论
update_comment 更新评论
delete_comment 删除评论
get_threaded_comments 获取评论回复
create_threaded_comment 回复评论

附件(1)

工具 说明
create_task_attachment 将文件上传到任务

自定义字段(7)

工具 说明
get_list_custom_fields 获取列表字段
get_folder_custom_fields 获取文件夹字段
get_space_custom_fields 获取空间字段
get_workspace_custom_fields 获取所有工作区字段
set_custom_field_value 在任务上设置字段
remove_custom_field_value 从任务中删除字段
get_custom_task_types 获取自定义任务类型

标签(6)

工具 说明
get_space_tags 在空间中获取标签
create_space_tag 创建标签
update_space_tag 更新标签
delete_space_tag 删除标签
add_tag_to_task 标记任务
remove_tag_from_task 取消标记任务

目标和关键成果(8)

工具 说明
get_goals 获取工作空间目标
create_goal 设定一个目标
get_goal 获取目标详细信息
update_goal 更新目标
delete_goal 删除目标
create_key_result 创建关键结果
update_key_result 更新关键结果
delete_key_result 删除关键结果

时间追踪(14)

工具 说明
get_time_entries 获取时间条目
create_time_entry 记录时间条目
get_time_entry 获取单个条目
update_time_entry 更新条目
delete_time_entry 删除条目
get_time_entry_history 获取入场历史记录
get_running_time_entry 获取运行计时器
start_time_entry 启动计时器
stop_time_entry 停止计时器
get_time_entry_tags 获取时间标签
add_tags_to_time_entries 为条目添加标签
remove_tags_from_time_entries 删除标签
update_time_entry_tags 重命名标签

成员(2)

工具 说明
get_task_members 获取任务成员
get_list_members 获取列表成员

用户(4)

工具 说明
invite_user_to_workspace 邀请用户
get_user 获取用户信息
update_user 更新用户
remove_user_from_workspace 删除用户

客人(10)

工具 说明
invite_guest_to_workspace 邀请客人
get_guest 获取客人信息
update_guest 更新访客
remove_guest_from_workspace 删除访客
add_guest_to_task 将客人添加到任务中
remove_guest_from_task 从任务中删除
add_guest_to_list 将客人添加到列表
remove_guest_from_list 从列表中删除
add_guest_to_folder 将访客添加到文件夹
remove_guest_from_folder 从文件夹中删除

用户组(4)

工具 说明
get_user_groups 获取群组
create_user_group 创建组
update_user_group 更新组
delete_user_group 删除组

角色(1)

工具 说明
get_custom_roles 获取自定义角色

浏览次数(12)

工具 说明
get_workspace_views 获取工作区视图
create_workspace_view 创建工作空间视图
get_space_views 获取空间视图
create_space_view 创建空间视图
get_folder_views 获取文件夹视图
create_folder_view 创建文件夹视图
get_list_views 获取列表视图
create_list_view 创建列表视图
get_view 获取查看详细信息
update_view 更新视图
delete_view 删除视图
get_view_tasks 查看任务

Webhooks(4)

工具 说明
get_webhooks 获取webhooks
create_webhook 创建webhook
update_webhook 更新webhook
delete_webhook 删除webhook

模板(1)

工具 说明
get_task_templates 获取任务模板

共享层次结构(1)

工具 说明
get_shared_hierarchy 获取共享项目

使用示例

获取所有工作区

# The tool will return all workspaces you have access to
result = await get_workspaces()

任务

result = await create_task(
    list_id="12345",
    name="My new task",
    description="Task description",
    priority=2,  # High priority
    assignees=[12345678],
    due_date=1735689600000  # Unix timestamp in ms
)

开始时间跟踪

result = await start_time_entry(
    team_id="123456",
    task_id="abc123",
    description="Working on feature",
    billable=True
)

创建一个网络钩子

result = await create_webhook(
    team_id="123456",
    endpoint="https://your-server.com/webhook",
    events=["taskCreated", "taskUpdated"],
    space_id="789"  # Optional: limit to specific space
)

Webhook事件

可用的webhook事件:

  • 任务: taskCreated, taskUpdated, taskDeleted, taskPriorityUpdated, taskStatusUpdated, taskAssigneeUpdated, taskDueDateUpdated, taskTagUpdated, taskMoved, taskCommentPosted, taskCommentUpdated, taskTimeEstimateUpdated, taskTimeTrackedUpdated
  • 列表: listCreated, listUpdated, listDeleted
  • 文件夹: folderCreated, folderUpdated, folderDeleted
  • 空间: spaceCreated, spaceUpdated, spaceDeleted
  • 目标: goalCreated, goalUpdated, goalDeleted
  • 关键结果: keyResultCreated, keyResultUpdated, keyResultDeleted

使用 * 订阅所有活动。

API 参考

此MCP服务器实现 点击API第2版.有关详细的参数文档,请参阅API官方文档。

发展

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check .

许可证

MIT许可证-请参阅许可证文件。

贡献

欢迎投稿!请在GitHub上打开问题或PR。