使用说明
ClickUp与MCP集成
一个模型上下文协议服务器,它与ClickUp实现无缝集成,使大型语言模型能够与您的ClickUp工作区任务和数据进行交互。
可用工具
此MCP服务器提供了以下工具用于与ClickUp进行交互:
任务管理
- **
clickup_create_task**在您的ClickUp工作区中创建一个新任务 - **
clickup_get_task**使用任务ID检索特定任务的详细信息 - **
clickup_get_task_by_custom_id**使用自定义ID检索任务信息 - **
clickup_update_task**根据任务ID更新现有任务 - **
clickup_update_task_by_custom_id**根据自定义ID更新现有任务 - **
get_list_tasks**从列表中获取所有任务,可选择性过滤
文档管理
- **
clickup_search_docs**在特定父级中搜索文档 - **
clickup_create_doc**在ClickUp中创建一个新文档 - **
clickup_get_doc_pages**从ClickUp文档中获取所有页面 - **
clickup_get_page**从ClickUp文档中获取特定页面 - **
clickup_create_page**在ClickUp文档中创建一个新页面 - **
clickup_edit_page**在ClickUp文档中编辑现有页面
自定义字段
- **
clickup_get_list_custom_fields**获取列表中所有可访问的自定义字段 - **
clickup_set_custom_field_value**为任务中的自定义字段设置一个值 - **
clickup_set_custom_field_value_by_custom_id**使用任务的自定义ID设置自定义字段值
受让人(或被指定人)
- **
get_list_assignees**获取列表中的所有成员(潜在分配者)
工作区结构
- **
get_spaces**获取工作区中的所有空间 - **
get_folders**获取空间中的所有文件夹 - **
get_lists**获取文件夹中的所有列表 - **
create_list**在文件夹中创建一个新列表
传输协议
这个MCP服务器支持两种传输协议:
标准I/O传输(默认)
- 与Cline和Claude桌面版一起使用
- 最适合本地发展
- 无需额外配置
HTTP 可流式传输
- 对于外部HTTP客户端和服务器部署
- 支持服务器发送事件(SSE)以进行流传输
- 具有可配置超时时间的会话管理
- 看 TRANSPORT_SETUP.md 翻译为中文是:“传输设置.md” 或 “运输配置.md”(具体翻译可能根据上下文有所调整,但“设置”和“配置”在此处均可作为“_SETUP”的合适翻译) 用于详细配置
构建
运行:
npm i
npm run build
npm run inspector
使用不同传输方式运行
Stdio(默认):
npm start
HTTP:
MCP_TRANSPORT=http MCP_HTTP_PORT=3000 npm start
Docker 构建
标准I/O传输:
docker build -t {your-docker-repository}:latest .
HTTP传输:
docker build \
--build-arg MCP_TRANSPORT=http \
--build-arg MCP_HTTP_PORT=3000 \
--build-arg MCP_HTTP_HOST=0.0.0.0 \
-t {your-docker-repository}:http .
多平台构建:
docker buildx build -t {your-docker-repository} --platform linux/amd64,linux/arm64 .
docker push {your-docker-repository}
使用 Docker Compose:
# Run Stdio version
docker-compose --profile stdio up
# Run HTTP version
docker-compose --profile http up
设置
1. 获取您的ClickUp API令牌:
- 登录您的ClickUp账户,网址为 app.clickup.com 翻译成中文可以是:“ClickUp 应用官网”或“ClickUp 应用平台”。这里,“app”通常指的是应用程序,“clickup.com”是该应用的官方网站域名。
- 点击左下角的个人资料图片,进入您的用户设置
- 选择“设置”
- 点击左侧边栏中的“应用”
- 在“API令牌”下,如果没有令牌,请点击“生成”
- 复制生成的API令牌,以便在MCP服务器配置中使用
2. 查找您的工作区ID:
- 在您的网络浏览器中打开ClickUp
- 当你在工作区时,查看一下网址
- 工作区ID是URL中的数字值:
https://app.clickup.com/{workspace_id}/home - 复制此号码以用于MCP服务器配置
3. 安装Docker: https://docs.docker.com/engine/install/ 的中文翻译可以是:“Docker 引擎安装文档”
环境变量
所需变量
| 变量 | 描述 | 示例 |
|---|---|---|
CLICKUP_API_TOKEN 您的ClickUp API令牌 pk_49310457_... |
||
CLICKUP_WORKSPACE_ID |
您的ClickUp工作区ID | 37261194 |
传输配置
| 变量 | 默认值 | 描述 |
|---|---|---|
MCP_TRANSPORT |
stdio |
传输协议: stdio 或者 http |
MCP_HTTP_PORT |
3000 |
HTTP 服务器端口(仅限 HTTP 传输) |
MCP_HTTP_HOST |
127.0.0.1 |
HTTP服务器主机(仅限HTTP传输) |
MCP_HTTP_ENDPOINT |
/mcp |
MCP 端点路径(仅限 HTTP 传输) |
MCP_HTTP_SESSION_TIMEOUT |
3600000 |
会话超时时间(毫秒) |
MCP_HTTP_MAX_CONNECTIONS |
100 |
最大并发连接数 |
MCP_HTTP_REQUEST_TIMEOUT |
30000 |
请求超时时间(毫秒) |
有关详细的HTTP传输配置,请参阅 TRANSPORT_SETUP.md 翻译为中文是:“传输设置.md”(注:这里的“.md”通常表示Markdown文件格式,但在中文语境下,我们通常不会特别指出文件扩展名,除非在需要明确文件类型的情况下。因此,也可以简单翻译为“传输设置(Markdown文件)”或根据上下文省略扩展名,直接翻译为“传输设置”。)。
4a. 设置Cline MCP服务器:
- 打开VSCode或JetBrains系列的集成开发环境(IDE),然后进入Cline。
- 前往MCP服务器 → 已安装 → 配置MCP服务器。
- 在你的(内容/列表/计划等)中添加以下内容:
cline_mcp_settings.json在……里面mcpServers密钥:
"clickup": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"CLICKUP_API_TOKEN",
"-e",
"CLICKUP_WORKSPACE_ID",
"your-docker-repository"
],
"env": {
"CLICKUP_API_TOKEN": "your-api-token",
"CLICKUP_WORKSPACE_ID": "your-workspace-id"
}
}
4b. 设置Claude桌面MCP服务器:
- 使用任意编辑器打开Claude Desktop的配置文件。
- Windows(系统/平台):
C:\Users\YourUsername\AppData\Roaming\Claude\claude_desktop_config.json - Mac:
~/Library/Application\ Support/Claude/claude_desktop_config.json
- Windows(系统/平台):
- 在你的(内容/项目/等)中添加以下内容
claude_desktop_config.json在……里面mcpServers密钥:
"clickup": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"CLICKUP_API_TOKEN",
"-e",
"CLICKUP_WORKSPACE_ID",
"your-docker-repository"
],
"env": {
"CLICKUP_API_TOKEN": "your-api-token",
"CLICKUP_WORKSPACE_ID": "your-workspace-id"
}
}
- 保存配置文件
- 重启Claude桌面应用以应用更改
故障排除
如果您在使用MCP服务器时遇到问题:
-
认证错误:
- 验证您的API令牌是否正确
- 确保API令牌具有您尝试执行的操作所需的权限
- 检查您的工作区ID是否正确
-
任务访问问题:
- 确认您有权访问您试图检索的任务
- 验证任务ID是否正确且存在于您的工作区中
- 检查任务是否可能处于存档状态
-
连接问题:
- 确保您的Docker服务正在正常运行
- 检查您的网络连接
- 验证您的MCP配置中环境变量是否设置正确
许可证
这个MCP服务器遵循MIT许可证进行授权。这意味着,您可以在遵守MIT许可证条款和条件的前提下,自由地使用、修改和分发该软件。