使用说明
ClickUp MCP-优化的AI集成
用于将ClickUp与AI应用程序集成的高性能模型上下文协议(MCP)服务器。这个优化的fork具有整合的工具、响应优化和智能缓存,可实现卓越的性能。
🚀 关键优化
此存储库基于原始ClickUp MCP服务器构建,性能和效率得到了显著提高:
- 工具整合:根据MCP设计原则,从36个工具减少到15个基于行动的综合工具
- 响应优化:通过智能字段过滤和数据扁平化减少54%的令牌
- 智能高速缓存:15分钟TTL工作区层次缓存,性能提高85%
- 混合查找:ID可用时直接调用API,需要时回退到缓存层次结构
- AI优先设计:围绕用户意图而非API结构设计的工具
性能结果
| 操作 | 之前 | 之后 | 改进 |
|---|---|---|---|
| 响应令牌(7个任务) | 723 | 331 | 减少54% |
| 工作区查找(热) | 2400ms | 350ms | 速度提高85% |
| 任务搜索(缓存) | 3000ms | 350ms | 速度提高88% |
需求
- Node.js v18.0.0或更高版本 (MCP SDK兼容性所需)
- 点击API密钥和团队ID
安装
快速入门(推荐)
将此添加到您的Claude Desktop配置文件中:
视窗: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"ClickUp": {
"command": "npx",
"args": [
"-y",
"@twofeetup/clickup-mcp@latest"
],
"env": {
"CLICKUP_API_KEY": "your-api-key-here",
"CLICKUP_TEAM_ID": "your-team-id-here"
}
}
}
}
获取您的凭据:
- 单击API键: 单击向上设置
- 团队ID:在您的ClickUp工作区URL中找到
重新启动Claude Desktop,服务器将自动安装并准备使用!
地方发展设置
- 克隆此存储库:
git clone https://github.com/TwoFeetUp/clickup-mcp.git
cd clickup-mcp
- 安装依赖项:
npm install
- 构建项目:
npm run build
-
获取您的凭据:
- 来自的ClickUp API键 单击向上设置
- ClickUp工作区URL中的团队ID
-
配置您的MCP客户端(例如,Claude Desktop):
将此条目添加到客户端的MCP设置JSON文件中:
{
"mcpServers": {
"ClickUp": {
"command": "node",
"args": [
"/path/to/clickup-mcp/build/index.js"
],
"env": {
"CLICKUP_API_KEY": "your-api-key",
"CLICKUP_TEAM_ID": "your-team-id"
}
}
}
}
整合工具
此服务器提供15个整合工具,而不是原来的36个:
任务管理
- 管理任务:使用基于操作的路由创建、更新、删除、移动或复制任务
- 搜索任务:按ID、列表或具有可配置详细级别的工作区范围过滤器查找任务
- 任务注释:获取或创建任务注释
- 任务时间跟踪:管理时间条目(获取、开始、停止、添加、删除)
- 附件_文件_任务:将文件附加到任务
容器管理
- 管理者_容器:创建、更新、删除或获取列表和文件夹
- get_container:检索集装箱详细信息
文档管理
- manage_document:创建、更新、删除文档
- manage_document_page:创建、更新、删除文档页面
- list_文档:列出工作区中的所有文档
组织
- find_members:按姓名/电子邮件搜索工作区成员
- operate_tags:创建、更新、删除或列出标记
批量操作
- bulk_create_tasks:高效地创建多个任务
- bulk_update_tasks:一次更新多个任务
- bulk_delet_tasks:在一次操作中删除多个任务
主要特点
AI第一工具设计
- 按用户意图而非API结构组织的工具
- 自然语言参数名称
- 支持灵活的任务标识(ID、名称或自定义ID)
- 细节级别控制(最低、标准、详细)
响应优化
- 自动字段过滤和空值删除
- 嵌套对象展平(状态→ 字符串,受让人→ 用户名)
- 令牌效率的可配置细节级别
- 对大型结果集的分页支持
性能特点
- 15分钟TTL工作空间层次缓存
- 提供ID时直接查找API
- 优雅地回退到缓存层次结构
- 自动缓存失效
- 速率限制感知(600ms间隔)
开发者体验
- 全面的TypeScript类型
- 详细的日志记录和操作跟踪
- 一致的错误处理
- 使用有用消息进行输入验证
配置
环境变量:
CLICKUP_API_KEY:您的ClickUp API密钥(必需)CLICKUP_TEAM_ID:您的ClickUp团队/工作区ID(必填)LOG_LEVEL:记录详细程度(默认值:“info”)
发展
# Install dependencies
npm install
# Build
npm run build
# Watch mode (for development)
npm run dev
# Run tests
node test-cache-performance.js
node test-optimized-response.js
建筑
此服务器遵循MCP设计原则:
- 工具整合:将相关操作分组到具有动作参数的单个工具中
- 代币效率:通过字段选择和详细程度优化响应格式
- 演出:智能缓存和直接API故障
- 可维护性:关注点明确分离,模式一致
看 MCP_DESIGN_PRINCIPLES.md 详细的设计理念。
许可证
麻省理工学院
学分
此优化版本建立在原始版本的基础上 点击MCP服务器 由Talib Kareem开发,具有重大的架构改进和性能优化。
North Timemensma的优化。
