Skip to content

Commit 6769cf0

Browse files
committed
improve documentation
1 parent 75217e6 commit 6769cf0

File tree

2 files changed

+76
-33
lines changed

2 files changed

+76
-33
lines changed

README.md

Lines changed: 75 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -74,38 +74,81 @@ Turn natural language into powerful ClickUp actions:
7474
- **Append-Only Descriptions**: Description fields are never overwritten - new content is safely appended with timestamps
7575
- **Normal Field Updates**: Status, priority, assignees, tags, and dates can be updated normally (easily revertible through ClickUp's history)
7676

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.
117+
118+
**Where to add this configuration:**
119+
- **Claude Desktop**: Settings > Developer > Edit Config
120+
- **Windsurf**: Add to your MCP configuration file
121+
- **Cursor**: Configure through the MCP settings panel
122+
123+
### Option 3: Coding Tools Integration
124+
125+
**Claude Code (CLI):**
126+
```bash
127+
claude mcp add clickup \
128+
--env CLICKUP_API_KEY=YOUR_KEY \
129+
--env CLICKUP_TEAM_ID=YOUR_ID \
130+
--env CLICKUP_MCP_MODE=read-minimal \
131+
--env MAX_IMAGES=16 \
132+
--env MAX_RESPONSE_SIZE_MB=4 \
133+
-- npx -y @hauptsache.net/clickup-mcp
134+
```
135+
136+
> Claude Code can handle a lot of images, thus the recommended increased limits.
137+
138+
> Note the `CLICKUP_MCP_MODE=read-minimal`. This is my usage recommendation, but feel free to use one of the other modes.
139+
140+
**OpenAI Codex:**
141+
Add these lines to your `~/.codex/config.toml` file:
142+
```toml
143+
[mcp_servers.clickup]
144+
command = "npx"
145+
args = ["-y", "@hauptsache.net/clickup-mcp@latest"]
146+
env = { "CLICKUP_API_KEY" = "YOUR_KEY", "CLICKUP_TEAM_ID" = "YOUR_ID", "CLICKUP_MCP_MODE" = "read-minimal" }
147+
```
148+
149+
> Codex seems to not be able to handle images from MCP's. See [this issue](https://github.com/openai/codex/issues/3741) for more details.
150+
151+
> Note the `CLICKUP_MCP_MODE=read-minimal`. This is my usage recommendation, but feel free to use one of the other modes.
109152
110153
## MCP Modes & Available Tools
111154

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
"clickup_team_id": {
9191
"type": "string",
9292
"title": "ClickUp Team ID",
93-
"description": "Your ClickUp Team ID (the ~7 digit number in the URL when in settings)",
93+
"description": "Your ClickUp Team ID (the 7–10 digit number in the URL when in settings)",
9494
"required": true
9595
},
9696
"clickup_primary_language": {

0 commit comments

Comments
 (0)