使用说明
项目简介
ClickUp MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在使 AI 助手能够与 ClickUp 工作空间进行交互。通过提供一系列工具,AI 助手可以执行如创建和更新任务、检索团队和列表、创建看板等操作,从而实现更智能的工作流程自动化。
主要功能点
- 任务管理:创建和更新 ClickUp 中的任务。
- 团队和列表管理:检索用户可访问的团队和特定文件夹下的列表。
- 看板管理:在 ClickUp 工作空间中创建新的看板。
- OAuth 2.0 认证:使用 OAuth 2.0 流程安全认证 ClickUp 账户。
- 可扩展的工具集:允许 AI 助手通过标准化的 MCP 协议调用 ClickUp 功能。
安装步骤
- 确保已安装 Node.js 和 npm。
- 克隆仓库到本地:
git clone https://github.com/Nazruden/clickup-mcp-server.git cd clickup-mcp-server - 安装项目依赖:
npm install
服务器配置
为了让 MCP 客户端(如 Claude for Desktop)连接到 ClickUp MCP Server,您需要在客户端中配置服务器启动命令和参数。以下是 Claude for Desktop 的配置示例,请根据您的 MCP 客户端进行相应配置:
{ "mcpServers": { "clickup": { "command": "npx", "args": ["@mcp/clickup-server"], "env": { "CLICKUP_CLIENT_ID": "your_client_id", // 您的 ClickUp OAuth 客户端 ID "CLICKUP_CLIENT_SECRET": "your_client_secret", // 您的 ClickUp OAuth 客户端密钥 "CLICKUP_REDIRECT_URI": "http://localhost:3000/oauth/callback" // OAuth 重定向 URI,通常无需修改 } } } }
配置参数说明:
- command: MCP 服务器的启动命令,这里使用 'npx' 来运行 '@mcp/clickup-server' 包。
- args: 启动命令的参数,这里为空数组。
- env: 环境变量配置,包含连接 ClickUp API 所需的 OAuth 凭据:
- CLICKUP_CLIENT_ID: 您的 ClickUp OAuth 客户端 ID,您需要在 ClickUp 开发者平台创建 OAuth 应用以获取。
- CLICKUP_CLIENT_SECRET: 您的 ClickUp OAuth 客户端密钥,与客户端 ID 一起在 ClickUp 开发者平台获取。
- CLICKUP_REDIRECT_URI: OAuth 重定向 URI,用于 ClickUp 授权后跳转回服务器。默认设置为 'http://localhost:3000/oauth/callback',通常情况下无需修改。
注意: 请务必替换 'your_client_id' 和 'your_client_secret' 为您在 ClickUp 开发者平台申请的 OAuth 应用凭据。
基本使用方法
- 启动服务器: 在项目根目录下运行以下命令启动 ClickUp MCP Server:
或者在开发模式下运行:npm startnpm run dev - 配置 MCP 客户端: 将上述 JSON 配置添加到您的 MCP 客户端配置中,并确保环境变量配置正确。
- 使用 AI 助手: 配置完成后,您的 AI 助手即可通过 MCP 协议与 ClickUp MCP Server 通信,并调用预定义的工具来操作 ClickUp 工作空间。例如,您可以指示 AI 助手创建一个新的 ClickUp 任务或查询团队信息。
可用工具 (Tools):
- 'clickup_create_task': 创建任务
- 'clickup_update_task': 更新任务
- 'clickup_get_teams': 获取团队列表
- 'clickup_get_lists': 获取列表
- 'clickup_create_board': 创建看板
具体工具的使用方法和参数定义请参考仓库 'README.md' 文件或 'src/index.ts' 中的工具定义。
信息
分类
生产力应用