使用说明
点击MCP服务器
模型上下文协议(MCP)服务器,使人工智能助手能够与ClickUp的任务管理API进行交互。此服务器通过自然语言提供全面的任务管理功能,专注于基本的项目工作流程,而不是ClickUp的完整功能集。
由 Diversio 团队致力于简化人工智能驱动的任务管理。
🚀 此服务器提供什么
✅ 核心任务管理
- 任务CRUD操作 -创建、读取、更新和删除任务
- 任务组织 -导航空间、文件夹和列表
- 任务搜索和筛选 -根据各种标准查找任务
- 评论与协作 -阅读任务并创建评论
- 用户和任务管理 -列出用户,按姓名/电子邮件查找,分配任务
- 状态管理 -更新和跟踪任务状态
✅ 生产率特征
- 批量操作 -一次更新或移动多个任务
- 时间跟踪 -记录时间并查看跟踪的小时数
- 任务模板 -从预定义的模板创建任务(错误报告、功能请求、代码审查)
- 任务链 -创建依赖任务序列
- 团队分析 -查看工作负载分布和完成指标
✅ 灵活的ID支持
- 标准点击ID(
abc123) - 自定义ID模式(
gh-123,bug-456) - 点击URL(
https://app.clickup.com/t/abc123) - 哈希格式(
#123)
❌ 不包括什么
此服务器侧重于任务管理要点。 不支持:
- 点击文档/文档
- 白板
- 仪表盘
- 自动化/工作流程
- 目标/指标
- 文件/附件管理
- Webhook管理
- 高级自定义字段操作
- 日历视图
- 表单集成
API覆盖范围: 约占ClickUp完整API的30-40%,涵盖最常见的任务管理工作流。
安装
快速入门(推荐)
# Install from GitHub (latest)
uvx --from git+https://github.com/DiversioTeam/clickup-mcp clickup-mcp
# Or from PyPI (when published)
uvx clickup-mcp
开发安装
git clone https://github.com/DiversioTeam/clickup-mcp
cd clickup-mcp
uv sync
uv run clickup-mcp
配置
API密钥设置
# Set your ClickUp API key
uvx clickup-mcp set-api-key YOUR_API_KEY_HERE
# Or set environment variable
export CLICKUP_MCP_API_KEY=your_api_key
获取您的点击API密钥
分步说明:
- 登录ClickUp 在 https://app.clickup.com
- 导航到“设置”:
- 点击左下角的头像/个人资料图片
- 从下拉菜单中选择“设置”
- 转到应用程序部分:
- 在左侧边栏中,单击“应用程序”
- 然后点击“API”(或直接进入 https://app.clickup.com/settings/apps)
- 生成API令牌:
- 单击“生成”按钮创建新的个人API令牌
- 重要:此令牌只显示一次!
- 复制并保存:
- 立即复制生成的令牌
- 安全存储(建议使用密码管理器)
- 使用以下方式配置它:
uvx clickup-mcp set-api-key YOUR_TOKEN_HERE
重要提示:
- 个人API令牌与您的用户帐户具有相同的权限
- 确保您的令牌安全-将其视为密码
- 如果你丢失了令牌,你需要重新生成一个新的令牌
- 令牌不会过期,但可以在同一设置页面中撤销
使用AI助手
克劳德代码(CLI)
添加到 ~/.config/claude-code/mcp-settings.json:
{
"servers": {
"clickup": {
"command": "uvx",
"args": ["--from", "git+https://github.com/DiversioTeam/clickup-mcp.git", "clickup-mcp"]
}
}
}
克劳德桌面版
添加到您的Claude Desktop配置文件中:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
视窗: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/claude/claude_desktop_config.json
{
"mcpServers": {
"clickup": {
"command": "uvx",
"args": ["--from", "git+https://github.com/DiversioTeam/clickup-mcp.git", "clickup-mcp"]
}
}
}
VS Code
VS Code通过本机集成和扩展提供了出色的MCP支持。提供多种设置选项:
选项1:原生VS代码MCP(推荐)
VS Code现在具有内置的MCP支持,包括GitHub Copilot和代理模式。添加到您的工作区:
创建 .vscode/mcp.json 在您的项目中:
{
"servers": {
"clickup": {
"command": "uvx",
"args": ["--from", "git+https://github.com/DiversioTeam/clickup-mcp.git", "clickup-mcp"]
}
}
}
或添加到VS Code用户设置:
- 打开命令选项板(
Ctrl+Shift+P/Cmd+Shift+P) - 运行“首选项:打开用户设置(JSON)”
- 添加到设置:
{
"mcp": {
"servers": {
"clickup": {
"command": "uvx",
"args": ["--from", "git+https://github.com/DiversioTeam/clickup-mcp.git", "clickup-mcp"]
}
}
}
}
选项2:支持MCP的VS代码扩展
副驾驶MCP扩展:
- 从VS代码市场安装“Copilot MCP”
- 直接从VS Code搜索、管理和安装MCP服务器
- 该扩展将帮助您配置ClickUp MCP服务器
Cline(AI编码助手):
- 安装“Cline”扩展,用于支持MCP的高级AI编码
- 通过Cline的设置配置ClickUp MCP服务器
用VS代码管理MCP服务器
- 打开命令选项板(
Ctrl+Shift+P/Cmd+Shift+P) - 跑 “MCP:列出服务器” 查看已配置的服务器
- 选择ClickUp服务器 启动/停止/重新启动 或查看日志
- 使用 “MCP:显示输出” 用于调试
验证VS代码设置
- 确保您的ClickUp API密钥已配置:
uvx clickup-mcp set-api-key YOUR_KEY - 在VS Code中,询问GitHub Copilot: “您能使用MCP工具列出我的ClickUp空间吗?”
- 使用命令面板检查MCP服务器状态→ “MCP:列出服务器”
可用工具(28个工具)
📝 任务管理
create_task-创建新任务get_task-获取任务详细信息(支持各种ID格式)update_task-更新任务属性delete_task-删除任务create_task_from_template-从预定义模板创建create_task_chain-创建依赖任务序列
🔍 任务发现
list_tasks-列出具有筛选选项的任务search_tasks-按文本和条件搜索任务get_subtasks-获取父级的所有子任务get_task_comments-获取任务评论create_task_comment-对任务创建评论
👥 任务和状态
get_task_status-获取当前任务状态update_task_status-更改任务状态get_assignees-列出任务分配人assign_task-为用户分配任务
🗂️ 导航
list_spaces-列出工作区中的所有空间list_folders-列出空间中的文件夹list_lists-列出所有列表find_list_by_name-按名称查找列表
⚡ 批量操作
bulk_update_tasks-一次更新多个任务bulk_move_tasks-将多个任务移动到不同的列表中
⏱️ 时间跟踪
get_time_tracked-跟踪用户/时段的时间log_time-记录在任务上花费的时间
📊 分析
get_team_workload-查看团队成员之间的任务分配get_task_analytics-获取速度指标和完成率
👤 用户管理
list_users-列出工作区中的所有用户get_current_user-获取当前经过身份验证的用户详细信息find_user_by_name-按姓名或电子邮件查找用户
示例用法
自然语言命令
问你的AI助手:
"Create a bug report for login issues in the Development list"
"Show me all high-priority tasks assigned to me"
"Move all completed tasks from Sprint 1 to Archive"
"Log 2 hours on task gh-123 for debugging"
"What's our team's current workload?"
"Create a task chain: Design → Implement → Test → Deploy"
"Add a comment to task GH-3761 saying 'testing complete'"
"Get all comments on the bug report task"
"Comment on task abc123 and assign it to John"
任务模板
"Create a bug report template for the payment processing issue"
"Use the code review template for PR #456"
"Create a feature request for dark mode"
分析查询
"What's our task completion rate this month?"
"Who has the most tasks assigned?"
"Show me time tracked on the API project"
发展
运行测试
# Run all tests (62 tests)
uv run pytest
# Run with coverage
uv run pytest --cov=clickup_mcp
# Run specific test
uv run pytest tests/test_client.py::test_create_task
代码质量
# Check code style
uv run ruff check .
# Format code
uv run ruff format .
# Type checking
uv run mypy src/
故障排除
检查配置
# Verify API key is configured
uv run clickup-mcp check-config
# Test API connection
uv run clickup-mcp test-connection
调试模式
# Run with debug logging
uv run clickup-mcp --debug
使用Claude代码进行本地测试
# Add the server for local testing with Claude Code CLI
claude mcp add clickup-local -- uv run clickup-mcp
# Then you can test the functionality immediately
# Example: List spaces, create tasks, add comments, etc.
技术限制
- 速率限制:无内置速率限制(点击率:100次/分钟)
- 分页:有限的分页支持
- 缓存:未实现响应缓存
- 自定义字段:模型存在,但工具支持有限
- 错误恢复:基本错误处理,无需复杂的重试
贡献
我们欢迎捐款!重点领域:
优先改进
- 增强的错误处理和重试逻辑
- 响应缓存实现
- 更好的分页支持
- 扩展的自定义字段支持
如何做出贡献
- 复刻仓库
- 创建要素分支(
git checkout -b feature/improvement) - 进行更改并添加测试
- 确保所有测试通过(
uv run pytest) - 跑linting(
uv run ruff check .) - 提交拉取请求
开发设置
git clone https://github.com/yourusername/clickup-mcp
cd clickup-mcp
uv sync
uv run pytest # Ensure tests pass
支持
许可证
MIT许可证-请参阅 许可证 文件以获取详细信息。
