使用说明
用于将ClickUp任务与AI应用程序集成的模型上下文协议(MCP)服务器。该服务器允许AI代理通过标准化协议与ClickUp任务、空间、列表和文件夹进行交互。
🚀 状态更新: v0.7.2现在提供完整的时间跟踪支持和文档管理功能。
设置
- 获取您的凭据:
- 来自的ClickUp API键 单击向上设置
- ClickUp工作区URL中的团队ID
- 选择托管安装(发送webhooks)或NPX安装(下载到本地路径并安装依赖项)
- 使用自然语言管理您的工作空间!
Smithery安装(快速启动)
服务器托管在 史密瑟里。在那里,您可以预览可用的工具或复制命令以在特定的客户端应用程序上运行。
NPX安装
将此条目添加到客户端的MCP设置JSON文件中:
{
"mcpServers": {
"ClickUp": {
"command": "npx",
"args": [
"-y",
"@taazkareem/clickup-mcp-server@latest"
],
"env": {
"CLICKUP_API_KEY": "your-api-key",
"CLICKUP_TEAM_ID": "your-team-id",
"DOCUMENT_SUPPORT": "true"
}
}
}
}
或者使用以下npx命令:
npx -y @taazkareem/clickup-mcp-server@latest --env CLICKUP_API_KEY=your-api-key --env CLICKUP_TEAM_ID=your-team-id
Obs:如果您没有传递“DOCUMENT_SUPPORT”:“true”,则默认值为false,文档支持将不会处于活动状态。
此外,您还可以使用 DISABLED_TOOLS 环境变量或 --env DISABLED_TOOLS 禁用特定工具的参数。提供逗号分隔的工具名称列表以禁用(例如。, create_task,delete_task).
如果您在工具数量或任何上下文限制方面遇到问题,请禁用不需要的工具
特性
| 📝 任务管理 | 🏷️ 标签管理 |
|---|---|
| •创建、更新和删除任务 •在任何地方移动和复制任务 •支持单次和批量操作 •用自然语言设置开始/截止日期 •创建和管理子任务 •添加评论和附件 |
•创建、更新和删除空间标签 •在任务中添加和删除标签 •使用自然语言颜色命令 •自动对比前景颜色 •查看所有空间标签 •跨工作区的基于标签的任务组织 |
| ⏱️ 时间跟踪 | 🌳 工作区组织 |
| •查看任务的时间条目 •任务的开始/停止时间跟踪 •添加手动时间输入 •删除时间条目 •查看当前运行的计时器 •跟踪计费和非计费时间 |
•浏览空间、文件夹和列表 •创建和管理文件夹 •在空间内组织列表 •在文件夹中创建列表 •查看工作空间层次结构 •高效的路径导航 |
| 📄 文档管理 | ⚡ 集成功能 |
| •通过所有工作区列出文档 •文档页面列表 •文档页面详细信息 •文档创建 •文档页面更新(追加和前缀) |
•基于全局名称或ID的查找 •不区分大小写的匹配 •Markdown格式支持 •内置速率限制 •错误处理和验证 •全面的API覆盖范围 |
可用工具
| 工具 | 说明 | 必需参数 |
|---|---|---|
| get_works空间层次结构 | 获取工作区结构 | 无 |
| 创建任务 | 创建任务 | name, (listId/listName) |
| create_bulk_tasks | 创建多个任务 | tasks[] |
| update_task | 修改任务 | taskId/taskName |
| update_bulk_tasks | 更新多个任务 | tasks[] 带有ID或名称 |
| get_tasks | 从列表中获取任务 | listId/listName |
| 获取任务 | 获取单任务详细信息 | taskId/taskName (巧妙地消除歧义) |
| get_workspace_tasks | 使用筛选获取任务 | 至少一个筛选器(标签、list_ids、空格_ids等) |
| get_ask_comments | 获取任务的评论 | taskId/taskName |
| 创建任务注释 | 向任务添加注释 | commentText, (taskId/(taskName+listName)) |
| 附件任务文件 | 将文件附加到任务 | taskId/taskName, (file_data 或 file_url) |
| 删除任务 | 删除任务 | taskId/taskName |
| delete_bulk_tasks | 删除多个任务 | tasks[] 带有ID或名称 |
| 移动任务 | 移动任务 | taskId/taskName, listId/listName |
| move_bulk_tasks | 移动多个任务 | tasks[] 带有ID或名称的目标列表 |
| 重复任务 | 复制任务 | taskId/taskName, listId/listName |
| create_list | 在空间中创建列表 | name, spaceId/spaceName |
| 创建文件夹 | 创建文件夹 | name, spaceId/spaceName |
| create_list_in_folder | 在文件夹中创建列表 | name, folderId/folderName |
| 获取文件夹 | 获取文件夹详细信息 | folderId/folderName |
| update_folder | 更新文件夹属性 | folderId/folderName |
| 删除文件夹 | 删除文件夹 | folderId/folderName |
| get_list | 获取列表详细信息 | listId/listName |
| update_list | 更新列表属性 | listId/listName |
| delete_list | 删除列表 | listId/listName |
| get_space_tags | 获取空间标签 | spaceId/spaceName |
| create_space_tag | 创建标签 | tagName, spaceId/spaceName |
| update_space_tag | 更新标签 | tagName, spaceId/spaceName |
| delete_space_tag | 删除标签 | tagName, spaceId/spaceName |
| add_tag_to_totask | 向任务添加标签 | tagName, taskId/(taskName+listName) |
| remove_tag_from_task | 从任务中删除标记 | tagName, taskId/(taskName+listName) |
| get_task_time_entrys | 获取任务的时间条目 | taskId/taskName |
| 开始时间跟踪 | 任务的开始时间跟踪 | taskId/taskName |
| 停止时间跟踪 | 停止当前时间跟踪 | 无 |
| add_time_entry | 向任务添加手动时间输入 | taskId/taskName, start, duration |
| delete_time_entry | 删除时间条目 | timeEntryId |
| get_current_time_entry | 获取当前正在运行的计时器 | 无 |
| 创建_文档 | 创建文档 | workspaceId, name, parentId/parentType, visibility, create_pages |
| get_document | 获取文档 | workspaceId/documentId |
| list_文档 | 列出文件 | workspaceId, documentId/creator/deleted/archived/parent_id/parent_type/limit/next_cursor |
| list_document_pages | 列出文档页面 | documentId/documentName |
| get_document_pages | 获取文档页面 | documentId/documentName, pageIds |
| create_document_pages | 创建文档页面 | workspaceId/documentId, parent_page_id/name/sub_title,content/content_format |
| update_document_page | 更新文档页面 | workspaceId/documentId, name/sub_title,content/content_edit_mode/content_format |
看 全部文件 用于可选参数和高级用法。
鼓励
尚未实现,并非所有客户端应用程序都支持。请求一个对您的工作流程最有利的快速实现功能(不要太具体)。示例:
| 提示 | 目的 | 功能 |
|---|---|---|
| 总结任务 | 任务概述 | 状态摘要、优先级、关系 |
| 分析优先级 | 优先级优化 | 分布分析、排序 |
| generate-description | 任务描述创建 | 目标、标准、依赖关系 |
错误处理
服务器为以下对象提供明确的错误消息:
- 缺少必要参数
- ID或名称无效
- 未找到项目
- 权限问题
- API错误
- 速率限制
这 LOG_LEVEL 可以指定环境变量来控制服务器日志的详细程度。有效值为 trace, debug, info, warn,以及 error (默认)。
这也可以在命令行上指定,例如。 --env LOG_LEVEL=info.
支持开发者
使用此服务器时,您可能偶尔会在工具响应中看到一条小赞助商消息,其中包含指向此存储库的链接。我希望你能支持这个项目! 如果你觉得这个项目有用,请考虑支持:
致谢
特别感谢 点击上 他们出色的API和服务使这种集成成为可能。
贡献
欢迎投稿!请阅读我们的 贡献指南 了解详情。
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
免责声明
此软件使用第三方API,并可能引用商标 或第三方拥有的品牌。使用此类API或引用并不意味着 与各公司的任何关联或由其背书。所有商标和 品牌名称是其各自所有者的财产。这个项目是一个独立的 工作,与上述任何第三方公司没有正式关联或赞助。