article
README
🚀 ClickUp MCP 服务器
ClickUp MCP 服务器是一个与 ClickUp 集成的 Model Context Protocol 服务器实现,它能让 AI 助手与 ClickUp 工作区进行交互,为用户提供更智能、便捷的工作体验。
🚀 快速开始
配置 Claude 桌面版
首先,您需要对 Claude 桌面版进行配置,具体配置内容如下:
{
"mcpServers": {
"clickup": {
"command": "npx",
"args": ["@mcp/clickup-server"],
"env": {
"CLICKUP_CLIENT_ID": "your_client_id",
"CLICKUP_CLIENT_SECRET": "your_client_secret",
"CLICKUP_REDIRECT_URI": "http://localhost:3000/oauth/callback"
}
}
}
}
重启 Claude 桌面版
完成上述配置后,重启 Claude 桌面版。之后,当有需要时,服务器会自动下载并启动。
通过 Smithery 安装
您也可以通过 Smithery 自动安装 ClickUp MCP Server 用于 Claude 桌面版,使用以下命令:
npx -y @smithery/cli install @Nazruden/clickup-mcp-server --client claude
📦 安装指南
环境变量
在使用该服务器时,需要设置一些环境变量,具体如下:
所需环境变量
CLICKUP_CLIENT_ID:您的 ClickUp OAuth 客户端 IDCLICKUP_CLIENT_SECRET:您的 ClickUp OAuth 客户端密钥CLICKUP_REDIRECT_URI:OAuth 重定向 URI(默认:http://localhost:3000/oauth/callback)
可选环境变量
PORT:服务器端口(默认:3000)LOG_LEVEL:日志级别(默认:info)
💻 使用示例
可用工具
任务管理
clickup_create_task:在 ClickUp 列表中创建新任务clickup_update_task:更新现有任务的属性
团队和列表管理
clickup_get_teams:检索所有可访问的团队clickup_get_lists:获取特定文件夹中的所有列表
布告板管理
clickup_create_board:在 ClickUp 空间中创建新布告板
🔧 技术细节
开发步骤
克隆仓库
首先,将项目仓库克隆到本地。
安装依赖项
使用以下命令安装项目所需的依赖项:
npm install
以开发模式启动
使用以下命令以开发模式启动项目:
npm run dev
构建生产版本
使用以下命令构建项目的生产版本:
npm run build
运行测试
使用以下命令运行项目的测试:
npm test
安全措施
- 所有令牌均加密存储,保障数据安全。
- 使用 OAuth2 流程进行安全身份验证,确保用户身份的合法性。
- 不记录敏感数据,保护用户隐私。
- 实现速率限制以防止 API 滥用,保证服务的稳定性。
📚 详细文档
常见问题
身份验证错误
- 验证环境变量中的 OAuth 凭据是否正确。
- 检查令牌是否过期。
- 确保重定向 URI 正确。
速率限制
- 服务器实现自动速率限制处理。
- 查看日志中的速率限制警告。
- 考虑实施请求批量处理。
服务器未启动
- 检查环境变量是否正确设置。
- 验证端口 3000 是否可用。
- 检查 Claude 桌面版日志。
获取日志
Claude 桌面版的日志位置如下:
- Windows:
%USERPROFILE%\AppData\Local\Claude\Logs\mcp*.log - macOS:
~/Library/Logs/Claude/mcp*.log
📄 许可证
本项目采用 MIT License,详情请参阅 LICENSE 文件。
微信扫一扫