You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+75-32Lines changed: 75 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,38 +74,81 @@ Turn natural language into powerful ClickUp actions:
74
74
-**Append-Only Descriptions**: Description fields are never overwritten - new content is safely appended with timestamps
75
75
-**Normal Field Updates**: Status, priority, assignees, tags, and dates can be updated normally (easily revertible through ClickUp's history)
76
76
77
-
## Setup for Claude Desktop, Windsurf, or Cursor
78
-
79
-
1.**Prerequisites**:
80
-
- Your `CLICKUP_API_KEY` (Profile Icon > Settings > Apps > API Token ~ usually starts with pk_)
81
-
- and your `CLICKUP_TEAM_ID` (The ~7 digit number in the url when you are in the settings)
82
-
83
-
2.**Configuration**:
84
-
Add the following to your MCP configuration file:
85
-
86
-
```json
87
-
{
88
-
"mcpServers": {
89
-
"clickup": {
90
-
"command": "npx",
91
-
"args": [
92
-
"@hauptsache.net/clickup-mcp@latest"
93
-
],
94
-
"env": {
95
-
"CLICKUP_API_KEY": "your_api_key",
96
-
"CLICKUP_TEAM_ID": "your_team_id"
97
-
}
98
-
}
99
-
}
100
-
}
101
-
```
102
-
103
-
Replace `your_api_key` and `your_team_id` with your actual ClickUp credentials.
104
-
105
-
3.**Connect Your AI Assistant**:
106
-
-**Claude Desktop**: Add this configuration in Settings > Developer > Edit Config
107
-
-**Windsurf**: Add to your MCP configuration file
108
-
-**Cursor**: Configure through the MCP settings panel
77
+
## Installation
78
+
79
+
### Prerequisites
80
+
81
+
For all installation methods, you'll need:
82
+
- Your `CLICKUP_API_KEY` (Profile Icon > Settings > Apps > API Token ~ usually starts with pk_)
83
+
- Your `CLICKUP_TEAM_ID` (The 7–10 digit number in the URL when you are in the settings)
84
+
85
+
### Option 1: MCPB Bundle (Recommended for Claude Desktop)
86
+
87
+
Download the pre-built bundle from our [releases page](https://github.com/hauptsacheNet/clickup-mcp/releases). This method requires no Node.js installation.
88
+
89
+
You'll get a configuration screen where you are prompted to enter your API key and team ID.
90
+
91
+
### Option 2: NPX Installation
92
+
93
+
This method automatically updates to the latest version and is preferred for users who want the newest features.
94
+
95
+
**For Claude Desktop, Windsurf, Cursor and others:**
96
+
97
+
Add the following to your MCP configuration file:
98
+
99
+
```json
100
+
{
101
+
"mcpServers": {
102
+
"clickup": {
103
+
"command": "npx",
104
+
"args": [
105
+
"@hauptsache.net/clickup-mcp@latest"
106
+
],
107
+
"env": {
108
+
"CLICKUP_API_KEY": "your_api_key",
109
+
"CLICKUP_TEAM_ID": "your_team_id"
110
+
}
111
+
}
112
+
}
113
+
}
114
+
```
115
+
116
+
Replace `your_api_key` and `your_team_id` with your actual ClickUp credentials.
0 commit comments