关键词

ClickUp任务管理项目管理AI助手工作流自动化

ClickUp MCP Server 使用说明

项目简介

ClickUp MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，它充当 AI 助手与 ClickUp 项目管理工具之间的桥梁。通过此服务器，AI 助手可以以标准化的方式访问和操作 ClickUp 中的任务、列表、文件夹等资源，并执行预定义的功能，从而实现智能化的任务和项目管理。

主要功能点

  • 工作区导航：允许 AI 助手浏览 ClickUp 工作区的层级结构，包括空间、文件夹和列表。
  • 任务管理：支持任务的创建、更新、移动、复制、删除和检索，包括批量创建任务。
  • 列表和文件夹操作：支持列表和文件夹的创建、更新、删除和检索，帮助组织和管理工作空间。
  • 任务关系管理：支持设置和管理任务之间的依赖关系和链接，以及为任务添加和移除标签。
  • 评论管理：提供全面的评论管理功能，包括任务评论、列表评论和聊天视图评论，支持线程评论的创建和检索。
  • 清单管理：支持在任务中创建和管理清单，以及清单条目的创建、编辑和删除。
  • 可扩展性：服务器设计为易于扩展，方便用户根据 ClickUp API 添加新的工具和功能。

安装步骤

  1. 克隆仓库

    git clone https://github.com/v4lheru/clickup-mcp-server.git
cd clickup-mcp-server

  2. 安装依赖

    npm install

  3. 配置环境变量 复制 '.env.example' 文件为 '.env'，并根据您的 ClickUp 账户信息填写以下环境变量：

    CLICKUP_API_KEY=您的_ClickUp_API_密钥
CLICKUP_TEAM_ID=您的_ClickUp_团队ID

    请确保您已在 ClickUp 中获取 API 密钥和团队 ID。

  4. 构建项目

    npm run build

  5. 启动服务器

    node build/index.js

    服务器成功启动后，即可等待 MCP 客户端连接。

服务器配置 (MCP 客户端配置)

要使 MCP 客户端（例如 Claude）连接到 ClickUp MCP Server，您需要配置客户端的 MCP 服务器设置。以下是 Claude 客户端的配置示例（JSON 格式）：

{
  "clickup": {
    "command": "curl",
    "args": ["-s", "http://your-server-address.railway.app"]
  }
}

配置参数说明:

  • server_name: 为您的服务器连接指定一个名称，例如 "clickup"，在Claude客户端中用于标识和选择此服务器。
  • command: MCP 客户端用于与服务器通信的命令。这里使用 'curl'，表示客户端将使用 curl 命令发送请求到服务器。
  • args: 'command' 命令的参数列表。
    • '"-s"': curl 的参数，表示静默模式，curl 将不会显示进度条和错误信息。
    • '"http://your-server-address.railway.app"': 请替换为您的 ClickUp MCP Server 部署后的实际 URL 地址。这是 MCP 客户端连接到服务器的关键地址。

注意:

  • 请将 'http://your-server-address.railway.app' 替换为您实际部署的服务器地址。如果您在本地运行服务器，并且希望本地 Claude 客户端连接，可以使用 'http://localhost:3000' (假设服务器监听 3000 端口，但此仓库默认配置并非监听端口服务，而是stdio，故此处配置railway部署地址更符合仓库默认配置的用法).
  • MCP 客户端 不需要 配置 'CLICKUP_API_KEY' 和 'CLICKUP_TEAM_ID' 等环境变量。这些敏感信息应仅配置在 服务器端 的环境变量中，以确保安全。MCP 客户端只需配置连接服务器的地址即可。

基本使用方法

  1. 确保 ClickUp MCP Server 已经成功启动并运行。
  2. 在支持 MCP 协议的 AI 助手（如 Claude）中，按照客户端的 MCP 服务器配置方法，添加上述 JSON 配置信息，并替换为您的服务器地址。
  3. 连接成功后，AI 助手即可使用预定义的工具与您的 ClickUp 工作空间进行交互。例如，您可以指示 AI 助手创建任务、查询任务状态、更新任务信息等。

扩展服务器功能

如果您需要添加新的 ClickUp API 工具，可以参考仓库 README.md 文件中 "Extending the Server" 部分的说明，按照步骤定义新的工具类型、实现服务方法、定义工具 Schema 和实现工具 Handler。

信息

分类

生产力应用

访问项目