Clickup MCP Server

🚀 ClickUp MCP 服务器交互指南

本指南将详细介绍 ClickUp MCP 服务器，它能增强 ClickUp 管理控制台协议 (MCP) 功能，为 AI 助手提供集成支持，助力您高效管理任务和工作流程。

🚀 快速开始

本指南将为您详细介绍如何与 ClickUp MCP 服务器进行交互，涵盖本地开发设置、Railway 部署、连接 AI 助手等内容。如果您有特定用例需求，如项目管理、产品开发等，也可随时咨询。

✨ 主要特性

增强功能

• 任务关系 API：支持创建和管理任务间的依赖关系、建立不同任务的关联以及为任务添加自定义标签进行分类。
• 评论 API：可在任务、列表及团队聊天界面中进行评论的添加、编辑和删除操作。

架构改进

• 模块化设计：通过定义类型、服务和工具处理逻辑，实现服务器的可扩展性。
• 遵循开闭原则：新增代码遵循开闭原则，便于后续维护和升级。

📦 安装指南

本地开发步骤

1. 克隆代码库：

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

2. 安装依赖：

npm install

3. 配置环境变量：设置 CLICKUP_API_KEY 环境变量。
4. 启动服务器：

npm run dev

Railway 部署步骤

1. 创建新应用并配置以下构建指令：

npm install && npm run build

2. 配置运行时指令：

npm start

3. 设置 CLICKUP_API_KEY 为密钥。

💻 使用示例

基础用法

// 创建任务依赖
await clickupMcp.createTaskDependency('task1', 'task2');

// 添加任务评论
await clickupMcp.addTaskComment('task1', '这是一个新的评论');

高级用法

若要扩展服务器以支持新的 ClickUp API 工具，可按以下步骤操作：

• 定义类型：

export interface NewClickupTool {
  id: string;
  name: string;
  description: string;
}

• 实现服务逻辑。

🔧 技术细节

类型定义

定义了任务关系和评论的输入输出数据格式，示例如下：

export interface TaskDependency {
  taskId: string;
  dependentTaskId: string;
}

服务实现

实现了与 ClickUp API 的交互逻辑，示例代码片段如下：

public async createTaskDependency(taskId: string, dependentTaskId: string): Promise<void> {
  try {
    const url = `/tasks/${taskId}/dependencies`;
    await this.axiosInstance.post(url, { taskId: dependentTaskId });
  } catch (error) {
    console.error('创建任务依赖失败:', error);
    throw error;
  }
}

如果您有任何问题或需要进一步的帮助，请随时联系！