关键词

clickup任务管理工作区自动化生产力

使用说明

项目简介

ClickUp MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在为 AI 应用提供与 ClickUp 项目管理工具集成的能力。通过此服务器，AI 客户端能够以标准化的方式访问和操作 ClickUp 中的任务、列表、文件夹、空间和标签等资源，并利用预定义的工具执行各种工作区管理操作。

主要功能点

  • 任务管理: 支持任务的创建、读取、更新、删除、移动、复制以及批量操作，包括设置截止日期、优先级、评论和附件等。
  • 工作区组织: 允许 AI 应用浏览和管理 ClickUp 的空间、文件夹和列表层级结构，方便用户进行工作区导航和组织。
  • 标签管理: 支持空间标签的创建、更新、删除和检索，以及为任务添加和移除标签，实现基于标签的任务组织和分类。
  • 工具集成: 提供一系列预定义的工具，例如获取工作区层级结构、创建/更新/删除任务、列表、文件夹和标签等，AI 应用可以通过调用这些工具与 ClickUp 进行交互。
  • 标准化协议: 采用 Model Context Protocol (MCP) 协议，确保与兼容 MCP 协议的 AI 客户端无缝对接。
  • 灵活部署: 支持 NPX 本地安装和 Smithery 托管安装，满足不同用户的部署需求。

安装步骤

  1. 获取 ClickUp API 凭据:

    • 访问 ClickUp 设置 获取 ClickUp API 密钥。
    • 从您的 ClickUp 工作区 URL 中获取团队 ID。

  2. 选择安装方式:

    • NPX 本地安装: 使用 NPX 命令将服务器下载到本地并安装依赖。
    • Smithery 托管安装: 使用 Smithery 平台提供的托管服务快速部署服务器。

以下以 NPX 本地安装 为例说明：

打开终端，复制粘贴以下 NPX 命令并执行：

npx -y @taazkareem/clickup-mcp-server@latest --env CLICKUP_API_KEY=your-api-key --env CLICKUP_TEAM_ID=your-team-id

请将 'your-api-key' 替换为您在 ClickUp 获取的 API 密钥，'your-team-id' 替换为您的 ClickUp 团队 ID。

服务器配置

MCP 服务器需要配置在 MCP 客户端中，以便客户端能够连接和使用该服务器提供的功能。以下是 MCP 客户端的 'mcpServers' 配置示例 (JSON 格式)：

{
  "mcpServers": {
    "ClickUp": {  // 服务器名称，可以自定义
      "command": "npx", // 启动服务器的命令，这里使用 npx
      "args": [  // 命令参数
        "-y",
        "@taazkareem/clickup-mcp-server@latest" // NPX 包名，指定要运行的 MCP 服务器
      ],
      "env": {  // 环境变量配置
        "CLICKUP_API_KEY": "your-api-key", // 您的 ClickUp API 密钥，请替换为实际密钥
        "CLICKUP_TEAM_ID": "your-team-id"  // 您的 ClickUp 团队 ID，请替换为实际 ID
      }
    }
  }
}

配置说明:

  • '"ClickUp"': 服务器名称，可以根据您的喜好自定义，用于在 MCP 客户端中标识该服务器。
  • '"command": "npx"': 指定启动服务器的命令为 'npx'，NPX 允许直接运行 npm 包，无需全局安装。
  • '"args": [...]"': 'args' 数组包含了 'npx' 命令的参数：
    • '"-y"': 'npx -y' 参数表示自动确认安装包，无需用户手动确认。
    • '"@taazkareem/clickup-mcp-server@latest"': 指定要运行的 npm 包为 '@taazkareem/clickup-mcp-server' 的最新版本。
  • '"env": {...}': 'env' 对象用于设置服务器运行所需的环境变量：
    • '"CLICKUP_API_KEY": "your-api-key"': 必须配置，ClickUp API 密钥，用于服务器访问 ClickUp API。
    • '"CLICKUP_TEAM_ID": "your-team-id"': 必须配置，ClickUp 团队 ID，指定服务器操作的 ClickUp 工作区。

请确保将 '"your-api-key"' 和 '"your-team-id"' 替换为您实际的 ClickUp API 密钥和团队 ID。

基本使用方法

  1. 启动 MCP 客户端: 配置完成后，启动您的 MCP 客户端应用。客户端将根据配置信息自动启动 ClickUp MCP Server。

  2. 通过 AI 客户端调用工具: 在 AI 客户端中，您可以使用自然语言指令，客户端会调用 ClickUp MCP Server 提供的工具来执行相应的 ClickUp 操作。例如：

    • "获取我的工作区结构" (对应 'get_workspace_hierarchy' 工具)
    • "创建一个名为 '每日站会' 的任务到 '每日任务' 列表" (对应 'create_task' 工具)
    • "更新任务 '每日站会' 的状态为 '进行中'" (对应 'update_task' 工具)

    具体的工具和使用参数请参考仓库 README.md 文件中 "Available Tools" 章节的详细描述。

  3. 查看服务器日志: 服务器日志默认输出到标准错误 (stderr)，您可以在 MCP 客户端的日志输出中查看服务器运行日志，排查问题。

注意: 此 MCP 服务器主要通过工具 (Tools) 提供功能，暂未实现 Prompt 模板 (Prompts) 功能。

信息

分类

生产力应用

访问项目