ClickUp MCP Server 使用说明
项目简介
ClickUp MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当连接 AI 应用和 ClickUp 任务管理平台的桥梁。通过这个服务器,AI 智能体可以以标准化的方式访问和操作 ClickUp 中的任务、列表、文件夹和空间,从而实现智能化的工作流程自动化和任务管理。
主要功能点
- 任务管理: 创建、更新、移动、复制和删除 ClickUp 中的任务,支持批量操作。
- 工作空间组织: 管理 ClickUp 工作空间的层级结构,包括空间、文件夹和列表,支持完整的CRUD操作和路径导航。
- 集成特性: 通过名称或ID查找项目,支持不区分大小写的名称匹配和Markdown格式,内置API速率限制以保证稳定运行。
- AI 辅助能力: 虽然仓库本身代码不直接包含AI分析功能,但其提供的工具和数据访问能力旨在为连接的AI应用提供结构化的ClickUp上下文信息,以便AI进行任务状态总结、优先级分析和描述生成等高级分析。
- 工具 (Tools): 提供了一系列预定义的工具,允许AI客户端调用以执行诸如获取工作区层级结构、创建/更新/删除任务、列表和文件夹等操作。
- Prompt 模板 (Prompts): 仓库文档中提及了Prompt模板,但代码中 'server.ts' 'ListPromptsRequestSchema' 和 'GetPromptRequestSchema' 的handler 均未实现具体功能,提示 "Prompt not found" 和返回空列表。实际功能集中在Tools上。
安装步骤
由于该仓库发布了 npm 包,可以直接通过 'npx' 命令快速启动,无需手动下载和编译代码。
-
获取 ClickUp API 密钥和团队 ID:
- 访问 ClickUp 设置 获取 API 密钥。
- 从您的 ClickUp 工作区 URL 中找到团队 ID (通常在 URL 中 'app.clickup.com/{team_id}/...')。
-
配置 MCP 服务器:
- 在支持 MCP 客户端的应用 (例如 Cursor Composer Agent) 中,进入 MCP 服务器配置页面。
- 添加新的 MCP 服务器配置,并填入以下启动命令,替换 'your_api_key_here' 和 'your_team_id_here' 为您在步骤 1 中获取的凭据。
npx -y @taazkareem/clickup-mcp-server \ --env CLICKUP_API_KEY=your_api_key_here \ --env CLICKUP_TEAM_ID=your_team_id_here -
保存配置: 点击 "Save" 或类似按钮保存 MCP 服务器配置。
服务器配置
对于 MCP 客户端,您需要提供 MCP 服务器的启动配置,以便客户端能够连接并与之通信。以下是 ClickUp MCP Server 的标准 JSON 格式服务器配置信息:
{ "serverName": "ClickUp MCP Server", "command": "npx", "args": [ "-y", "@taazkareem/clickup-mcp-server", "--env", "CLICKUP_API_KEY=<your_clickup_api_key>", // 替换为您的 ClickUp API 密钥 "--env", "CLICKUP_TEAM_ID=<your_clickup_team_id>" // 替换为您的 ClickUp 团队 ID ], "transport": "stdio" }
参数说明:
- 'serverName': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器。
- 'command': 启动服务器的命令,这里使用 'npx' 来运行 npm 包。
- 'args': 传递给 'npx' 命令的参数列表:
- '"-y"': 'npx' 参数,表示自动确认安装 npm 包。
- '"@taazkareem/clickup-mcp-server"': 要运行的 npm 包名称,即 ClickUp MCP Server。
- '"--env"' '"CLICKUP_API_KEY=<your_clickup_api_key>"': 通过环境变量传递 ClickUp API 密钥。请务必替换 '<your_clickup_api_key>' 为您真实的 API 密钥。
- '"--env"' '"CLICKUP_TEAM_ID=<your_clickup_team_id>"': 通过环境变量传递 ClickUp 团队 ID。请务必替换 '<your_clickup_team_id>' 为您真实的团队 ID。
- 'transport': 指定 MCP 服务器使用的传输协议,'stdio' 表示标准输入输出流,是 'npx' 启动的服务器默认的通信方式。
基本使用方法
配置完成后,在 MCP 客户端中,您可以使用自然语言指令,通过 AI 智能体与您的 ClickUp 工作区进行交互。例如,您可以:
- 使用自然语言创建新的 ClickUp 任务。
- 查询 ClickUp 中特定列表的任务。
- 更新现有任务的状态或截止日期。
- 获取工作空间的层级结构以便于理解项目组织。
具体的自然语言指令格式和支持的操作取决于您使用的 MCP 客户端的能力。请参考您使用的 MCP 客户端的文档,了解如何利用 ClickUp MCP Server 提供的工具进行交互。
注意: 首次使用或配置变更后,可能需要在 MCP 客户端中重新加载或重启 MCP 服务器连接,以确保配置生效。
信息
分类
生产力应用