使用说明

项目简介

'clickup-mcp' 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为大型语言模型 (LLM) 提供与 ClickUp 项目管理工具集成的能力。它允许 LLM 通过标准化的 MCP 协议访问和操作 ClickUp 中的任务、列表、文档等资源。

主要功能点

工具集成: 提供丰富的 ClickUp API 工具，例如获取任务、创建任务、更新列表、搜索文档等，使 LLM 能够与 ClickUp 工作区进行交互。
数据转换: 支持多种数据返回模式（Minimal, Important, Full），可以控制返回数据的详细程度，并支持嵌套字段处理，方便 LLM 理解和使用数据。
灵活配置: 允许用户通过配置文件轻松配置 ClickUp API Token 和服务器启动参数。
易于调试: 提供 MCP Inspector 和 Claude Desktop 错误日志，方便开发者调试和排查问题。

安装步骤

克隆仓库:

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

设置 Python 环境:

python -m venv .venv
source .venv/bin/activate  # On MacOS/Linux

或

.venv\Scripts\activate  # On Windows

安装依赖:

pip install -r requirements.txt

安装 clickup-mcp:
```
pip install -e .
```

服务器配置

为了让 MCP 客户端（如 Claude Desktop）连接到 'clickup-mcp' 服务器，需要配置服务器启动命令。以下是一个示例 JSON 配置，你需要根据你的实际环境进行调整：

{
  "mcpServers": {
    "clickup": {
      "command": "/path/to/your/repo/.venv/bin/python",
      "args": ["-m", "clickup.server"],
      "cwd": "/path/to/your/repo",
      "env": {
        "CLICKUP_API_TOKEN": "你的 ClickUp API Token"
      }
    }
  }
}

配置参数说明:

'server name': 服务器名称，这里是 'clickup'，可以自定义。
'command': Python 解释器路径，通常为项目虚拟环境中的 Python 可执行文件路径。
'args': 启动服务器的参数，'-m clickup.server' 表示运行 'clickup.server' 模块。
'cwd': 工作目录，设置为仓库根目录。
'env': 环境变量，'CLICKUP_API_TOKEN' 必须设置为你的 ClickUp API Token。

将以上 JSON 配置保存到 Claude Desktop 配置文件中：

macOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%\Claude\claude_desktop_config.json'

基本使用方法

启动 Claude Desktop (或其他 MCP 客户端)。
在 Claude 中，你可以使用自然语言指令调用 'clickup-mcp' 提供的工具。例如：
- 'List me tasks from the Clickup list [list id], do it in return_mode important' （获取指定列表的任务）
- 'Get the page id from this Clickup url ... and get the content from it using get-page tool' （获取 ClickUp 文档页面内容）
- 'Add a comment to the task '[task name]'' （为任务添加评论）

请参考仓库 README.md 文件和代码中的工具定义，了解更多可用的工具和使用方法。

关键词