2.2.0 • Published 7 months ago

@meepo-ab/clickup-mcp v2.2.0

Weekly downloads
-
License
MIT
Repository
-
Last release
7 months ago

ClickUp MCP Server

The ClickUp MCP Server is an implementation of the Model Context Protocol (MCP) for interacting with ClickUp. It enables AI-driven development workflows by allowing Large Language Models (LLMs) to interact with ClickUp through MCP, providing programmatic access to ClickUp features for AI assistants like Claude.

Features

This MCP server provides a comprehensive set of tools for interacting with ClickUp:

Workspace Navigation

  • Get Workspaces - Retrieve all available workspaces
  • Get Spaces - Get all spaces within a workspace
  • Get Folders - List all folders within a space
  • Get Lists - Retrieve lists within folders or spaces

Task Management

  • Create Tasks - Create new tasks with detailed information
  • Update Tasks - Modify existing tasks
  • Delete Tasks - Remove tasks when no longer needed
  • Find Tasks - Search for tasks by name or other criteria
  • Get Task Details - Retrieve comprehensive information about tasks

Subtasks and Checklists

  • Get Subtasks - Retrieve subtasks of a parent task
  • Create Subtasks - Break down tasks into smaller components
  • Manage Checklists - Create and manage checklists within tasks

Configuration

Prerequisites

  • A ClickUp account with a valid API key
  • An MCP client like Cursor or Claude

Cursor MCP Configuration

To use this MCP server with Cursor, create a .cursor/mcp.json file in your project directory with the following configuration:

{
  "mcpServers": {
    "clickup-mcp": {
      "command": "npx",
      "args": [
        "@meepo-ab/clickup-mcp"
      ],
      "env": {
        "CLICKUP_API_KEY": "your_clickup_api_key",
        "WORKSPACE_ID": "your_workspace_id",
        "SPACE_ID": "your_space_id",
        "LIST_ID": "your_list_id"
      }
    }
  }
}

Replace:

  • your_clickup_api_key with your ClickUp API key
  • your_workspace_id with your ClickUp workspace ID (optional)
  • your_space_id with your ClickUp space ID (optional)
  • your_list_id with your ClickUp list ID (optional)

⚠️ SECURITY NOTE: The .cursor/mcp.json file contains sensitive credentials. Make sure to:

  • Add .cursor/mcp.json to your .gitignore file to prevent accidentally committing it
  • Never share this file with others

Local Repository Configuration

To simplify working with ClickUp in a local repository, you can create an mcp-config.json file in your repository root. This allows you to configure default IDs for the ClickUp workspace hierarchy specific to this repository.

Example mcp-config.json:

{
  "clickup": {
    "workspaceId": "123",
    "spaceId": "456",
    "listId": "101112"
  }
}

When using the MCP tools with Cursor: 1. The LLM will first check for mcp-config.json in your repository 2. If found, it will use the configured IDs under the clickup section 3. If not found or if you need to use different IDs, you can provide them directly in your requests

Usage

The ClickUp MCP Server is designed to be used by AI assistants through the Model Context Protocol. It communicates over STDIO by default and is launched by an MCP client like Claude in Cursor.

When interacting with an AI assistant in Cursor, the assistant will have access to the ClickUp tools if properly configured, allowing you to:

  • Navigate and explore your ClickUp workspace hierarchy
  • Create and manage tasks
  • Work with subtasks and checklists
  • Find specific tasks and view details

Example Workflows

Task Creation Workflow:

  • Ask the AI to create a new task with specific details
  • The AI can handle task creation with appropriate title, description, and other parameters

Task Breakdown Workflow:

  • Request the AI to break down a complex task into subtasks
  • The AI can create a structured hierarchy of related tasks

Task Management:

  • Get an overview of tasks in a specific list
  • Update task details or status
  • Find tasks by name or criteria

Available Tools

Workspace Navigation

  • get_workspaces: Get all workspaces
  • get_spaces: Get spaces in a workspace
  • get_folders: Get folders in a space
  • get_folder_lists: Get lists in a folder
  • get_folderless_lists: Get lists not in any folder
  • get_all_lists: Get all lists in a space

Task Management

  • get_tasks: Get tasks from a specific list
  • get_task: Get details of a specific task
  • create_task: Create a new task
  • update_task: Update an existing task
  • delete_task: Delete a task
  • find_task: Find a task by name
  • get_subtasks: Get subtasks of a task

Development

If you want to contribute to this project or build it from source:

  1. Clone the repository:
git clone https://gitlab.com/meepoab/ai-labs/mcp-servers/clickup-mcp.git
cd clickup-mcp
  1. Install dependencies:
npm install
  1. Build the project:
npm run build

Available Scripts

  • npm run build - Build the TypeScript code
  • npm run dev - Watch for changes and rebuild automatically
  • npm test - Run tests
  • npm run lint - Lint the code
  • npm run format - Format the code with Prettier

Security

  • API keys can be provided via environment variables
  • No API keys are stored in the code or configuration files
  • Package access is restricted to Meepo organization members

Requirements

  • Node.js >= 16
  • npm with access to @meepo organization
  • ClickUp API key

Support

For internal support, please contact the Meepo development team.

License

MIT

2.2.0

7 months ago

2.1.5

7 months ago

2.1.4

7 months ago

2.1.3

9 months ago

2.1.2

9 months ago

2.1.1

10 months ago

2.1.0

10 months ago