ClickUp MCP Server 使用说明

项目简介

ClickUp MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 提供与 ClickUp 项目管理工具集成的能力。通过此服务器，LLM 可以调用预定义的工具来访问和操作 ClickUp 工作区中的任务信息，从而实现智能化的任务管理和工作流自动化。

主要功能点

ClickUp API 集成: 连接 ClickUp API，允许 LLM 安全地访问 ClickUp 数据。
任务信息检索: 提供多种工具来检索 ClickUp 任务，包括按任务 ID、自定义 ID 以及批量检索。
身份验证: 支持通过 ClickUp API Token 进行身份验证，确保访问安全。
标准化 MCP 接口: 遵循 MCP 协议标准，易于与支持 MCP 协议的 LLM 客户端集成。

安装步骤

获取代码: 克隆 GitHub 仓库到本地：

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

安装依赖 (npm 用户): 如果您使用 npm 运行，请安装项目依赖：
```
npm install
```
构建 Docker 镜像 (Docker 用户): 如果您选择使用 Docker 运行，请构建 Docker 镜像：
```
docker build -t mcp/clickup .
```

服务器配置

MCP 服务器需要配置 ClickUp API Token 和 Workspace ID 才能正常工作。您需要在 MCP 客户端的配置文件中指定服务器的启动命令和环境变量。以下是 Claude Desktop 的配置示例：

使用 npm 启动 (推荐本地开发和调试):

{
  "mcpServers": {
    "clickup": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-clickup"
      ],
      "env": {
        "CLICKUP_API_TOKEN": "<请替换为您的 ClickUp API Token>",  // 在 ClickUp 设置中生成 API Token
        "CLICKUP_WORKSPACE_ID": "<请替换为您的 ClickUp Workspace ID>" // 在 ClickUp URL 中找到 Workspace ID
      }
    }
  }
}

使用 Docker 启动 (推荐生产环境):

{
  "mcpServers": {
    "clickup": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "CLICKUP_API_TOKEN",
        "-e",
        "CLICKUP_WORKSPACE_ID",
        "mcp/clickup"
      ],
      "env": {
        "CLICKUP_API_TOKEN": "<请替换为您的 ClickUp API Token>",  // 在 ClickUp 设置中生成 API Token
        "CLICKUP_WORKSPACE_ID": "<请替换为您的 ClickUp Workspace ID>" // 在 ClickUp URL 中找到 Workspace ID
      }
    }
  }
}

配置说明:

'server name': 'clickup' (服务器名称，可以自定义)
'command': 服务器启动命令。'npx' 适合本地 npm 环境，'docker' 适合 Docker 容器环境。
'args': 命令参数。 'npx' 使用 '-y mcp-clickup' 运行，'docker' 使用 'run -i --rm -e CLICKUP_API_TOKEN -e CLICKUP_WORKSPACE_ID mcp/clickup' 运行。
'env': 环境变量配置。
- 'CLICKUP_API_TOKEN': 您的 ClickUp API 访问令牌。
- 'CLICKUP_WORKSPACE_ID': 您的 ClickUp 工作区 ID。

基本使用方法

启动 MCP 服务器: 根据您的配置选择 npm ('npm start') 或 Docker (Docker 客户端会自动运行)。
配置 MCP 客户端: 将上述 JSON 配置添加到您的 MCP 客户端 (例如 Claude Desktop) 的配置文件中。
调用工具: 在 LLM 客户端中，您可以使用以下工具与 ClickUp 进行交互：
- 'clickup_authenticate': 验证 ClickUp API 密钥和工作区 ID。
- 'clickup_get_task': 根据任务 ID 获取任务详情。
- 'clickup_get_task_by_custom_id': 根据自定义任务 ID 获取任务详情。
- 'clickup_get_tasks': 根据任务 ID 列表批量获取任务详情。
- LLM 将根据您的指令自动调用这些工具，并返回 ClickUp 的数据。

请确保您已在 ClickUp 中生成 API Token 并获取 Workspace ID，并将其正确配置到 MCP 客户端中。

关键词