mcp-clickup-server
v1.4.1
Published
MCP server para integrar ClickUp con OpenCode/Gentle AI — creá tareas y explorá tu workspace desde lenguaje natural
Maintainers
Readme
MCP ClickUp Server
A Model Context Protocol (MCP) server that connects ClickUp to your favorite AI coding tools. Create tasks, browse workspaces, assign work, and manage your project workflow using natural language.
Table of Contents
- Capabilities
- Installation
- Supported Tools
- Headless Mode
- Usage
- Updating
- Configuration
- API Key
- Per-Project Configuration
- Available Tools
- Development
- Troubleshooting
- License
Capabilities
| Action | Example Command | |--------|----------------| | Browse workspaces | "Show me my ClickUp workspaces" | | Explore lists | "What lists are in my space?" | | View statuses | "What statuses does the SIGESP list have?" | | View modules | "What modules are available?" | | View team members | "Who are the members of this workspace?" | | Create tasks | "Create a high-priority task in SIGESP called 'Review pending items' with module TESORERIA" | | Update tasks | "Change task 86cad8gv7 to completed with high priority" | | Assign tasks | "Assign task 86cad8gv7 to Luis Sanchez" | | Create subtasks | "Add a subtask to task 86cacpvg1" | | Add comments | "Add a comment to the task saying I already reviewed it" | | Delete tasks | "Delete the test task" | | List tasks | "Show me the pending tasks in SIGESP" |
Installation
Run the setup wizard from any project directory:
npx mcp-clickup-server setupThe wizard will:
- Ask for your ClickUp API key
- Save the key to a global configuration file
- Detect installed MCP-compatible tools and let you choose where to register the server
- Optionally link the current project to a ClickUp list
After setup, restart the IDE or AI tool where you installed the server. The ClickUp tools will be available immediately.
Tip: The setup never overwrites existing MCP servers unless you explicitly select that tool. It safely merges the ClickUp server into your existing configuration.
Supported Tools
The following MCP-compatible clients are supported. Detection and automatic configuration availability vary by platform.
| Tool | Detected Automatically | Configured Automatically | Notes |
|------|:----------------------:|:------------------------:|-------|
| OpenCode | ✓ | ✓ | |
| Antigravity (Google IDE) | ✓ | ✓ | |
| Cursor | ✓ | ✓ | |
| VS Code + Copilot | ✓ | ✓ | Uses the mcp / servers configuration |
| Claude Desktop | ✓ | ✓ | macOS / Windows / Linux paths supported |
| Claude Code | ✓ | ✓ | |
| ChatGPT Desktop | ✓ | ✓ | |
| Augment | ✓ | ✓ | |
| Auggie | ✓ | ✓ | |
| Windsurf | ✓ | ✓ | |
| Roo Code | ✓ | ✓ | Detected through the VS Code extension storage |
| n8n | ✗ | ✗ | Copy the MCP server command into the n8n workflow UI |
| Codex (OpenAI) | ✗ | ✗ | Add the command to your Codex configuration file |
| Add Agent (generic) | ✗ | ✗ | Paste the command into the agent's MCP settings |
If a tool is not detected automatically, you can still select it manually in the interactive wizard or use --targets in headless mode.
Headless Mode
For CI/CD, dotfiles, or when you already know which tools you want to configure, skip the interactive wizard:
# Detect installed tools without writing any configuration
npx mcp-clickup-server setup --detect-only
# Configure specific tools by their ID
npx mcp-clickup-server setup --targets cursor,claude-desktop,opencode
# Update only the project-level ClickUp list association
npx mcp-clickup-server reconfigureNote:
--reconfigureonly updates the project list association. It does not register the MCP server in IDEs. To register tools and update the project list, run setup first and then reconfigure.
Tool IDs
Use these IDs with --targets:
opencode, antigravity, cursor, vscode-copilot, claude-desktop, claude-code, chatgpt, augment, auggie, windsurf, roo-code, n8n, codex, add-agent
Usage
Once installed, interact with ClickUp using natural language. The assistant will call the appropriate tools automatically.
Examples:
- "Show me my workspaces"
- "Who are the members of this workspace?"
- "Create a task in SIGESP called 'Review Q3 budget' assigned to Luis"
- "What tasks are pending in this project?"
- "Add a comment to task 86cad8gv7 saying I reviewed it"
If a project has been configured with a ClickUp list, you can omit the list name and the assistant will use the configured list automatically.
Updating
Update to the latest version without losing your configuration:
npx mcp-clickup-server updateThis preserves your API key and per-project settings. If you installed via git, it pulls the latest code, installs dependencies, and rebuilds.
Reconfigure a project
To change which ClickUp list is associated with the current project:
npx mcp-clickup-server reconfigureThis skips the API key, dependency, and IDE registration steps and goes directly to the project configuration wizard.
Configuration
Automatic Configuration
npx mcp-clickup-server setup detects and configures supported tools automatically. No manual file editing is required.
Manual Configuration
If automatic detection fails or you prefer to configure a tool by hand, use the command below and add it to your tool's MCP settings:
node /path/to/MCP-CLICKUP/dist/index.jsEach client stores MCP servers differently. The setup wizard writes to the standard location for each tool; refer to your client's documentation for the exact file and schema.
OpenCode example:
In ~/.config/opencode/opencode.json:
{
"mcp": {
"clickup": {
"command": ["node", "/path/to/MCP-CLICKUP/dist/index.js"],
"type": "local",
"enabled": true
}
}
}Antigravity (Google IDE) example:
In ~/.gemini/config/mcp_config.json:
{
"mcpServers": {
"clickup": {
"command": "node",
"args": ["/path/to/MCP-CLICKUP/dist/index.js"]
}
}
}API Key
A ClickUp Personal API Token is required. Generate one at:
Settings > Apps > API Token or directly at https://app.clickup.com/settings/apps
The token begins with pk_. The server resolves the API key in the following priority order:
CLICKUP_API_KEYenvironment variable- Global configuration file at
~/.config/mcp-clickup-server/.env - Local
.envfile in the project directory
Per-Project Configuration
Each project can be associated with a specific ClickUp list, allowing the assistant to know where to create tasks without being told every time.
Setup
Run this in your project directory:
npx mcp-clickup-server setupDuring setup, you will be prompted to configure the current project. You can:
- Paste a ClickUp list URL — The setup parses the URL and extracts the list and workspace IDs.
- Browse workspaces interactively — Select from your workspaces, spaces, and lists.
- Enter a list ID manually — If you already know the ID.
- Skip — Configure later.
To change the configuration later, run:
npx mcp-clickup-server reconfigureManual Configuration
Create a .mcp-clickup.json file in your project root:
{
"project": "My Project",
"listId": "901513520682",
"listName": "SIGESP",
"workspaceId": "90151439364",
"workspaceName": "Ing. Aron Rojas."
}How It Works
When you ask the assistant to create a task or list tasks without specifying a list, the server checks for .mcp-clickup.json in the current project directory. If found, it uses the configured list automatically.
Available Tools
The server exposes 16 tools for ClickUp interaction:
| Tool | Description |
|------|-------------|
| get_workspaces | List all accessible workspaces |
| get_workspace_members | List members with IDs, names, and roles |
| get_authenticated_user | Get the current user's info (ID, name, email) |
| get_spaces | List spaces within a workspace |
| get_folders | List folders within a space |
| get_lists | List lists within a space or folder |
| get_list_statuses | View available statuses for a list |
| get_custom_fields | View custom fields (e.g., MODULE dropdown) |
| get_tasks | List tasks with optional filters (includes assignees) |
| get_task | Get detailed task information (includes assignees) |
| get_task_comments | View comments on a task |
| get_project_config | Get the project's associated ClickUp list |
| create_task | Create a complete task with all fields |
| update_task | Update an existing task |
| add_comment | Add a comment to a task |
| delete_task | Delete a task |
create_task Parameters
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| listId | string | No* | ClickUp list ID (falls back to project config) |
| name | string | Yes | Task title |
| description | string | No | Markdown-supported description |
| status | string | No | Initial status (e.g., "pendiente", "en curso") |
| priority | number | No | 1 (Urgent), 2 (High), 3 (Normal), 4 (Low) |
| dueDate | string | No | ISO date string or millisecond timestamp |
| startDate | string | No | Start date (ISO or timestamp) |
| tags | string[] | No | Tags for the task |
| assignees | number[] | No | User IDs to assign (use get_workspace_members to find IDs) |
| parent | string | No | Parent task ID for subtasks |
| customFields | array | No | Custom field values (e.g., module assignments) |
*listId is optional if the project has a .mcp-clickup.json configuration.
Development
npm run dev # Development mode with hot reload
npm run build # Compile TypeScript
npm start # Production mode
npm run update # Update from git (preserves config)Troubleshooting
"CLICKUP_API_KEY not found"
Run npx mcp-clickup-server setup to configure the API key.
ClickUp tools not appearing after setup Restart the IDE or AI tool where you installed the server, then verify the configuration file was updated.
A tool was not detected automatically
Use the --targets flag to force configuration, or add the server manually using the command shown in the Manual Configuration section.
Error: "Value must be an option index or uuid"
Use the get_custom_fields tool to retrieve the available option UUIDs for dropdown fields. Pass the option UUID (not the display name) in the customFields parameter.
Server fails to start
Ensure Node.js v20 or later is installed. Run npm run build to verify the TypeScript compiles successfully. Confirm that dist/index.js exists.
License
MIT
