Clickup MCP Server

## 🚀 ClickUp MCP Server Interaction Guide

This guide offers a comprehensive overview of the ClickUp MCP server, detailing how to set it up, connect it to AI assistants, and utilize its enhanced features.

## 🚀 Quick Start
Welcome to the ClickUp MCP Server Interaction Guide! I'm ready to assist you in leveraging this enhanced integration to support your AI assistant.

### What I Can Help With
- Steps for setting up the server locally or deploying it to Railway.
- Connecting the server to Claude or other AI assistants.
- Utilizing task relationship features (dependencies, links, tags).
- Using the comment API in task, list, and chat views.
- Extending the server to support new ClickUp API tools.

Please let me know if you need solutions for specific use cases, such as project management, product development, content calendars, or other workflows.

### Clear Explanation
I'll keep explanations clear and avoid excessive technical details unless you specifically request them.

## ✨ Features
### Project Introduction
The ClickUp MCP server is an enhanced version of the ClickUp Management Console Protocol (MCP) server, designed to provide integration support for AI assistants. It extends the original functionality by adding support for the task relationship API, including dependencies, links, tags, comments, and new ClickUp API tools.

### Enhanced Features
#### 1. Task Relationship API
- **Dependencies**: Create and manage dependencies between tasks.
- **Links**: Establish associations between different tasks.
- **Tags**: Add custom tags to tasks for classification.

#### 2. Comment API
- **Task Comments**: Add, edit, and delete comments on tasks.
- **List Comments**: Comment on multiple tasks in a list.
- **Chat View Comments**: Integrate comment functionality in the team chat interface.

### Architecture Improvements
- **Modular Design**: Achieve scalability by defining types, services, and tool processing logic.
- **Open/Closed Principle**: Newly added code adheres to the open/closed principle for easy maintenance and upgrades.

## 🔧 Technical Details
### 1. Type Definitions
- Define the input and output data formats for task relationships and comments.
- Example:
```typescript
export interface TaskDependency {
  taskId: string;
  dependentTaskId: string;
}

2. Service Implementations

• Implement the interaction logic with the ClickUp API.
• Example code snippet:

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('Failed to create task dependency:', error);
    throw error;
  }
}

📦 Installation

Local Development Steps

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Configure environment variables:

• Set the CLICKUP_API_KEY environment variable.

4. Start the server:

npm run dev

Railway Deployment Steps

1. Create a new application and configure the following build command:

npm install && npm run build

2. Configure the runtime command:

npm start

3. Set CLICKUP_API_KEY as a secret.

💻 Usage Examples

Connecting an AI Assistant

Integrate with your ClickUp account via RPC or HTTP requests.

Basic Usage

// Create a task dependency
await clickupMcp.createTaskDependency('task1', 'task2');

// Add a task comment
await clickupMcp.addTaskComment('task1', 'This is a new comment');

Advanced Usage

Extending the Server

To add support for new ClickUp API tools:

• Define types:

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

• Implement the service logic.

If you have any questions or need further assistance, please feel free to let me know!