article
README
🚀 ClickUp MCP 集成
ClickUp MCP 集成提供了一个 Model Context Protocol 服务器,它能与 ClickUp 实现无缝集成,让大型语言模型可以与 ClickUp 工作区的任务和数据进行交互。
🚀 快速开始
构建
要构建此项目,请执行以下命令:
# 安装依赖项
npm install
# 运行项目
node index.js
设置
配置
创建一个 config.json 文件并添加以下内容:
{
"clickup": {
"token": "your_clickup_api_token",
"space_id": "your_clickup_space_id"
}
}
环境变量
设置以下环境变量:
CLICKUP_TOKEN:ClickUp API 令牌CLICKUP_SPACE_ID:ClickUp 工作区 ID
✨ 主要特性
此 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_get_list_custom_fields:获取列表中所有可访问的自定义字段clickup_set_custom_field_value:为任务的自定义字段设置值clickup_set_custom_field_value_by_custom_id:使用任务的自定义 ID 设置自定义字段值
分配人员
get_list_assignees:获取列表中所有成员(潜在分配人员)
工作区结构
get_spaces:获取工作区get_space_users:获取工作区中的用户get_folders:获取文件夹get_folder_tasks:获取文件夹中的任务
🔧 故障排除
如果遇到 MCP 服务器的问题,请按照以下步骤进行故障排除:
- 身份验证错误:
- 验证 API 令牌是否正确
- 确保 API 令牌具有执行操作所需的权限
- 检查工作区 ID 是否正确
- 任务访问问题:
- 确认您是否有权访问正在尝试检索的任务
- 验证任务 ID 是否正确且存在于您的工作区中
- 检查任务是否可能处于存档状态
- 连接问题:
- 确保 Docker 服务正常运行
- 检查网络连接
- 验证环境变量在 MCP 配置中正确设置
📄 许可证
此 MCP 服务器根据 MIT 许可证分发。这意味着您可以在以下条件下自由使用、修改和分发该软件:遵守 MIT 许可证的条款和条件。
扫码联系在线客服