@taazkareem/clickup-mcp-server 0.2.3 → 0.2.4

package/README.md

@@ -12,7 +12,9 @@ Directions for use with Cursor Composer Agent:
 2. Go to Features in settings
 3. Add under MCP Servers:
 ```bash
-npx -y @taazkareem/clickup-mcp-server --env CLICKUP_API_KEY=your_api_key_here --env TEAM_ID=your_team_id_here
+npx -y @taazkareem/clickup-mcp-server \
+  --env CLICKUP_API_KEY=your_api_key_here \
+  --env CLICKUP_TEAM_ID=your_team_id_here
 ```
 4. Replace the credentials and click Save
 5. Use Natural Language to interact with your ClickUp Workspace!
@@ -31,7 +33,7 @@ npx -y @taazkareem/clickup-mcp-server --env CLICKUP_API_KEY=your_api_key_here --
   - List and folder management in spaces
   - Smart caching to reduce API calls
   - Name/ID-based item lookup
-  - Optimized task organization
+
 
 - 🔄 **Smart Integration**
   - Case-insensitive name lookups
@@ -47,61 +49,30 @@ npx -y @taazkareem/clickup-mcp-server --env CLICKUP_API_KEY=your_api_key_here --
 
 ## Available Tools
 
-### Workspace Tools
-**get_workspace_hierarchy**
-Returns complete workspace structure (spaces, folders, lists). No parameters required.
-
-### Task Tools
-**get_tasks** `(listId|listName)`
-Get tasks from list with optional filters (archived, page, order_by, reverse, subtasks, statuses, include_closed, assignees, due_date_gt/lt, custom_fields).
-
-**get_task** `(taskId|taskName, ?listName)`
-Get detailed task info including attachments and custom fields.
-
-**create_task** `(listId|listName, taskName)`
-Create task with optional description (markdown), status, priority (1-4), dueDate.
-
-**create_bulk_tasks** `(listId|listName, tasks[])`
-Bulk create tasks with automatic rate limiting. Each task: name (required), description, status, priority, dueDate (optional).
-
-**update_task** `(taskId|taskName, ?listName)`
-Update task name, description, status, priority (1-4), dueDate.
-
-**delete_task** `(taskId|taskName, ?listName)`
-Permanently delete a task.
-
-**move_task** `(taskId|taskName, destinationListId|destinationListName, ?sourceListName)`
-Move task to different list, preserving task data.
-
-**duplicate_task** `(taskId|taskName, destinationListId|destinationListName, ?sourceListName)`
-Create copy of task in specified list.
-
-### List & Folder Tools
-**create_list** `(spaceId|spaceName, listName)`
-Create list with optional content, dueDate, priority (1-4), assignee.
-
-**create_folder** `(spaceId|spaceName, folderName, ?overrideStatuses)`
-Create folder in space.
-
-**create_list_in_folder** `(folderId|folderName, listName)`
-Create list in folder with optional content and status.
+| Tool | Description | Required Parameters |
+|------|-------------|-------------------|
+| [get_workspace_hierarchy](docs/tools.md#workspace-organization) | Get complete workspace structure | None |
+| [get_tasks](docs/tools.md#task-management) | Retrieve tasks from a list | `listId` or `listName` |
+| [get_task](docs/tools.md#task-management) | Get single task details | `taskId` or `taskName` |
+| [create_task](docs/tools.md#task-management) | Create a new task | `listId`, `taskName` |
+| [create_bulk_tasks](docs/tools.md#task-management) | Create multiple tasks | `listId`, `tasks[]` |
+| [update_task](docs/tools.md#task-management) | Modify task properties | `taskId` or `taskName` |
+| [delete_task](docs/tools.md#task-management) | Remove a task | `taskId` or `taskName` |
+| [move_task](docs/tools.md#task-management) | Move task to another list | `taskId`, `destinationListId` |
+| [duplicate_task](docs/tools.md#task-management) | Copy task to another list | `taskId`, `destinationListId` |
+| [create_list](docs/tools.md#list-management) | Create a new list | `spaceId`, `listName` |
+| [create_folder](docs/tools.md#folder-management) | Create a new folder | `spaceId`, `folderName` |
+| [create_list_in_folder](docs/tools.md#list-management) | Create list in folder | `folderId`, `listName` |
+
+See [full documentation](docs/tools.md) for optional parameters and advanced usage.
 
 ## Available Prompts
 
-1. **summarize_tasks**
-   - Basic task summary by status
-   - Lists tasks with their current states
-   - Shows task relationships within lists
-
-2. **analyze_priorities**
-   - Reviews current task priorities
-   - Suggests priority adjustments
-   - Recommends task sequencing
-
-3. **generate_description**
-   - Interactive prompt for creating task descriptions
-   - Helps structure task information
-   - Includes objectives, criteria, and dependencies
+| Prompt | Purpose | Features |
+|--------|---------|----------|
+| [summarize_tasks](docs/tools.md#prompts) | Generate task overview | Status summary, relationships, current states |
+| [analyze_priorities](docs/tools.md#prompts) | Review task priorities | Priority review, adjustments, sequencing |
+| [generate_description](docs/tools.md#prompts) | Create task descriptions | Structure, objectives, dependencies |
 
 ## Error Handling
 
@@ -115,12 +86,9 @@ The server provides clear error messages for:
 
 ## Support the Developer
 
-If you find this project useful, please consider supporting the developer:
-Talib Kareem (taazkareem@icloud.com)
-
-[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-Support-orange)](https://www.buymeacoffee.com/taazkareem)
+If you find this project useful, please consider supporting
 
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" style="vertical-align: middle; margin-right: 4px;"><path d="M4 18h12l4-4h-12z" /><path d="M8 14l-4-4h12l4 4" /><path d="M16 10l4-4h-12l-4 4" /></svg><span style="vertical-align: middle;">**Solana Wallet:** `GjtRksihd7SWQw7hJSCDMcTxPHbgpNs7xPW3nFubNjVM`</span>
+[![Sponsor TaazKareem](https://img.shields.io/badge/Sponsor-TaazKareem-orange?logo=github)](https://github.com/sponsors/TaazKareem)
 
 ## Contributing
 

package/build/config.js

@@ -1,4 +1,3 @@
-// Parse command line arguments for --env flags
 const args = process.argv.slice(2);
 const envArgs = {};
 for (let i = 0; i < args.length; i++) {
@@ -6,16 +5,15 @@ for (let i = 0; i < args.length; i++) {
         const [key, value] = args[i + 1].split('=');
         if (key === 'CLICKUP_API_KEY')
             envArgs.clickupApiKey = value;
-        if (key === 'TEAM_ID')
-            envArgs.teamId = value;
-        i++; // Skip the next argument since we used it
+        if (key === 'CLICKUP_TEAM_ID')
+            envArgs.clickupTeamId = value;
+        i++;
     }
 }
 const configuration = {
-    clickupApiKey: envArgs.clickupApiKey || '',
-    teamId: envArgs.teamId || '',
+    clickupApiKey: envArgs.clickupApiKey || process.env.CLICKUP_API_KEY || '',
+    clickupTeamId: envArgs.clickupTeamId || process.env.CLICKUP_TEAM_ID || '',
 };
-// Check for missing environment variables
 const missingEnvVars = Object.entries(configuration)
     .filter(([_, value]) => !value)
     .map(([key]) => key);

package/build/index.js

@@ -25,7 +25,7 @@ import { CallToolRequestSchema, ListToolsRequestSchema, ListPromptsRequestSchema
 import { ClickUpService } from "./services/clickup.js";
 import config from "./config.js";
 // Initialize ClickUp service
-const clickup = ClickUpService.initialize(config.clickupApiKey, config.teamId);
+const clickup = ClickUpService.initialize(config.clickupApiKey, config.clickupTeamId);
 /**
  * Create an MCP server with capabilities for tools and prompts.
  * Resources have been removed as they are being replaced with direct tool calls.
@@ -48,7 +48,7 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
         tools: [
             {
                 name: "get_workspace_hierarchy",
-                description: "Get the complete hierarchy of spaces, folders, and lists in the workspace.  -First check chat history for space, folder, and list names or IDs.  If not found, use this tool to get necessary information.",
+                description: "Get the complete hierarchy of spaces, folders, and lists in the workspace.  Important: If looking up information, first check chat history for space, folder, and list names or ID matches.  If not found, use this tool to get necessary information.",
                 inputSchema: {
                     type: "object",
                     properties: {},
@@ -366,7 +366,7 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
             },
             {
                 name: "get_tasks",
-                description: "Get tasks from a ClickUp list with optional filters. Supports direct name-based lookup for lists - no need to know the list ID. If the list doesn't exist, you can create it using create_list or create_list_in_folder.",
+                description: "Get tasks from a ClickUp list with optional filters. Supports direct name-based lookup for lists - no need to know the list ID. If the list doesn't exist, you can create it using create_list or create_list_in_folder. ",
                 inputSchema: {
                     type: "object",
                     properties: {
@@ -852,7 +852,7 @@ server.setRequestHandler(GetPromptRequestSchema, async (request) => {
     try {
         switch (request.params.name) {
             case "summarize_tasks": {
-                const spaces = await clickup.getSpaces(config.teamId);
+                const spaces = await clickup.getSpaces(config.clickupTeamId);
                 const tasks = [];
                 // Gather all tasks
                 for (const space of spaces) {
@@ -893,7 +893,7 @@ server.setRequestHandler(GetPromptRequestSchema, async (request) => {
                 };
             }
             case "analyze_priorities": {
-                const spaces = await clickup.getSpaces(config.teamId);
+                const spaces = await clickup.getSpaces(config.clickupTeamId);
                 const tasks = [];
                 for (const space of spaces) {
                     const lists = await clickup.getLists(space.id);

package/build/services/clickup.js

@@ -6,10 +6,10 @@ import axios from 'axios';
 export class ClickUpService {
     client;
     static instance;
-    teamId;
+    clickupTeamId;
     rateLimitRemaining = 100; // Default to lowest tier limit
     rateLimitReset = 0;
-    constructor(apiKey, teamId) {
+    constructor(apiKey, clickupTeamId) {
         this.client = axios.create({
             baseURL: 'https://api.clickup.com/api/v2',
             headers: {
@@ -35,7 +35,7 @@ export class ClickUpService {
             }
             throw error;
         });
-        this.teamId = teamId;
+        this.clickupTeamId = clickupTeamId;
     }
     /**
      * Checks if we're close to hitting rate limits and waits if necessary.
@@ -73,13 +73,13 @@ export class ClickUpService {
     /**
      * Initializes the ClickUpService singleton instance.
      * @param apiKey - The ClickUp API key for authentication
-     * @param teamId - The team/workspace ID to operate on
+     * @param clickupTeamId - The team/workspace ID to operate on
      * @returns The singleton instance of ClickUpService
      * @throws Error if initialization fails
      */
-    static initialize(apiKey, teamId) {
+    static initialize(apiKey, clickupTeamId) {
         if (!ClickUpService.instance) {
-            ClickUpService.instance = new ClickUpService(apiKey, teamId);
+            ClickUpService.instance = new ClickUpService(apiKey, clickupTeamId);
         }
         return ClickUpService.instance;
     }
@@ -244,13 +244,13 @@ export class ClickUpService {
     }
     /**
      * Gets all lists in the workspace.
-     * @param teamId - ID of the team/workspace
+     * @param clickupTeamId - ID of the team/workspace
      * @returns Promise resolving to array of ClickUpList objects
      * @throws Error if the API request fails
      */
-    async getAllLists(teamId) {
+    async getAllLists(clickupTeamId) {
         return this.makeRequest(async () => {
-            const response = await this.client.get(`/team/${teamId}/list`);
+            const response = await this.client.get(`/team/${clickupTeamId}/list`);
             return response.data.lists;
         });
     }
@@ -267,9 +267,9 @@ export class ClickUpService {
         });
     }
     // Spaces
-    async getSpaces(teamId) {
+    async getSpaces(clickupTeamId) {
         return this.makeRequest(async () => {
-            const response = await this.client.get(`/team/${teamId}/space`);
+            const response = await this.client.get(`/team/${clickupTeamId}/space`);
             return response.data.spaces;
         });
     }
@@ -279,8 +279,8 @@ export class ClickUpService {
             return response.data;
         });
     }
-    async findSpaceByName(teamId, spaceName) {
-        const spaces = await this.getSpaces(teamId);
+    async findSpaceByName(clickupTeamId, spaceName) {
+        const spaces = await this.getSpaces(clickupTeamId);
         return spaces.find(space => space.name.toLowerCase() === spaceName.toLowerCase()) || null;
     }
     /**
@@ -448,7 +448,7 @@ export class ClickUpService {
     }
     async findListByNameGlobally(listName) {
         // First try the direct lists
-        const lists = await this.getAllLists(this.teamId);
+        const lists = await this.getAllLists(this.clickupTeamId);
         const directList = lists.find(list => list.name.toLowerCase() === listName.toLowerCase());
         if (directList)
             return directList;
@@ -477,9 +477,9 @@ export class ClickUpService {
      * @throws Error if API requests fail
      */
     async getWorkspaceHierarchy() {
-        const spaces = await this.getSpaces(this.teamId);
+        const spaces = await this.getSpaces(this.clickupTeamId);
         const root = {
-            id: this.teamId,
+            id: this.clickupTeamId,
             name: 'Workspace',
             type: 'workspace',
             children: []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taazkareem/clickup-mcp-server",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "ClickUp MCP Server - Integrate ClickUp tasks with AI through Model Context Protocol",
   "type": "module",
   "main": "build/index.js",