使用说明:

项目简介

ClickUp MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 AI 助手提供与 ClickUp 项目管理工具集成的标准化接口。通过此服务器,AI 系统可以安全、便捷地访问和操作 ClickUp 中的工作区、空间、列表、任务、文档、评论和检查清单等资源,实现智能化的项目管理和工作流自动化。

主要功能点

  • 数据访问能力: 提供对 ClickUp 工作区、空间、文件夹、列表、任务、文档、评论和检查清单等资源的读取能力。
  • 工具集成: 注册并提供一系列工具,允许 AI 助手调用 ClickUp API 执行操作,如获取工作区列表、空间列表、任务列表、创建和更新任务、获取文档内容、创建文件夹和列表等。
  • 标准化接口: 遵循 MCP 协议,提供统一的 JSON-RPC 接口,方便各种 MCP 客户端集成。
  • 易于配置: 通过简单的 JSON 配置文件即可完成服务器的部署和启动。
  • 多种安装方式: 支持本地克隆仓库安装和 npx 快速安装,满足不同用户的需求。

安装步骤

  1. 克隆仓库 (推荐):

    git clone https://github.com/nsxdavid/clickup-mcp-server.git
    cd clickup-mcp-server
  2. 安装依赖:

    npm install
  3. 构建项目:

    npm run build
  4. 获取 ClickUp API Token:

    • 登录您的 ClickUp 账户。
    • 进入 "Settings" (设置) > "Apps" (应用)。
    • 点击 "Generate API Token" (生成 API Token) 并复制您的 Token。

服务器配置

请将以下配置添加到您的 MCP 客户端设置文件 (例如 Cline VSCode Extension 或 Claude Desktop App 的 'cline_mcp_settings.json' 或 'claude_desktop_config.json'):

{
  "mcpServers": {
    "clickup": {
      "command": "node",
      "args": ["/path/to/clickup-mcp-server/build/index.js"],  // 请替换为 clickup-mcp-server 构建后 index.js 文件的实际路径
      "env": {
        "CLICKUP_API_TOKEN": "YOUR_API_TOKEN_HERE"  // 请替换为您的 ClickUp API Token
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

或者使用 npx 快速安装 (无需克隆仓库):

{
  "mcpServers": {
    "clickup": {
      "command": "npx",
      "args": [
        "-y",
        "clickup-mcp-server"
      ],
      "env": {
        "CLICKUP_API_TOKEN": "YOUR_API_TOKEN_HERE"  // 请替换为您的 ClickUp API Token
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

基本使用方法

  1. 确保已按照上述步骤配置 MCP 客户端并启动 ClickUp MCP Server。
  2. 在您的 MCP 客户端中,即可使用预定义的工具 (Tools) 与 ClickUp 进行交互。例如,您可以使用 'get_workspaces' 工具获取工作区列表,或使用 'get_tasks' 工具获取特定列表中的任务。
  3. 通过 MCP 客户端提供的界面或指令,调用相应的工具并传入必要的参数,即可访问和操作 ClickUp 数据。

请注意: 您需要将配置文件中的 '/path/to/clickup-mcp-server/build/index.js' 替换为 'clickup-mcp-server' 项目构建后 'build/index.js' 文件的实际路径,并将 'YOUR_API_TOKEN_HERE' 替换为您在 ClickUp 中生成的 API Token。

信息

分类

生产力应用