@taazkareem/clickup-mcp-server 0.4.49 → 0.4.51

package/Dockerfile.smithery

@@ -0,0 +1,36 @@
+# Use a Node.js base image
+FROM node:18-alpine AS builder
+
+# Set the working directory
+WORKDIR /app
+
+# Copy package files and TypeScript config
+COPY package.json package-lock.json tsconfig.json ./
+
+# Copy the source files
+COPY src/ ./src/
+
+# Install dependencies and build
+RUN npm install
+RUN npm run build
+
+# Use a smaller image for the runtime
+FROM node:18-alpine AS runtime
+
+# Set the working directory
+WORKDIR /app
+
+# Copy the build output and node_modules from the builder stage
+COPY --from=builder /app/build ./build
+COPY --from=builder /app/node_modules ./node_modules
+COPY --from=builder /app/package.json ./
+
+# Set environment variables (these will be overridden by Smithery)
+ENV CLICKUP_API_KEY=placeholder
+ENV CLICKUP_TEAM_ID=placeholder
+
+# Expose the port if needed
+EXPOSE 8080
+
+# Define the command to run the application
+CMD ["node", "build/index.js"] 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 taazkareem
+Copyright (c) 2025 Talib Kareem
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,10 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE. 
+SOFTWARE.
+
+Disclaimer: This software makes use of third-party APIs and may reference trademarks
+or brands owned by third parties. The use of such APIs or references does not imply 
+any affiliation with or endorsement by the respective companies. All trademarks and 
+brand names are the property of their respective owners. This project is an independent
+work and is not officially associated with or sponsored by any third-party company mentioned.

package/README.md

@@ -1,235 +1,97 @@
-# ClickUp MCP Server
+<img src="https://clickup.com/assets/brand/logo-v3-clickup-dark.svg" alt="ClickUp" height="40" style="vertical-align: middle; margin-top: -4px;">
+
+# MCP Server
 
 A Model Context Protocol (MCP) server for integrating ClickUp tasks with AI applications. This server allows AI agents to interact with ClickUp tasks, spaces, lists, and folders through a standardized protocol.
 
-## Features
+## Quick Start
 
-- 🔄 **Resource Management**
-  - List and read ClickUp tasks as resources
-  - View task details, status, and assignments
-  - Access task history and relationships
+Directions for use with Cursor Composer Agent:
 
-- 📂 **Workspace Organization**
-  - Create and manage spaces
-  - Create, update, and delete folders
-  - Create and manage lists (in spaces or folders)
-  - Flexible identification using IDs or names
-
-- ✨ **Task Operations**
-  - Create single or bulk tasks
-  - Move tasks between lists
-  - Duplicate tasks
-  - Set priorities and due dates
-  - Assign team members
-
-- 📊 **Information Retrieval**
-  - Get complete hierarchy of spaces, folders, and lists with IDs
-  - List available statuses
-  - Find items by name (case-insensitive)
-  - View task relationships
-
-- 🔍 **Smart Name Resolution**
-  - Use names instead of IDs for lists and folders
-  - Global search across all spaces
-  - Case-insensitive matching
-  - Automatic location of items
-
-- 📝 **AI Integration**
-  - Generate task descriptions with AI
-  - Summarize tasks and analyze priorities
-  - Get AI-powered task recommendations
-
-- 🔒 **Security**
-  - Secure API key management
-  - Environment-based configuration
-
-## Installation
-
-### Using npx
+1. Get your credentials:
+   - ClickUp API key from [ClickUp Settings](https://app.clickup.com/settings/apps)
+   - Team ID from your ClickUp workspace URL
+2. Go to Features in settings
+3. Add under MCP Servers:
 ```bash
-npx @taazkareem/clickup-mcp-server
-```
-
-## Configuration
-
-1. Get your ClickUp API key from [ClickUp Settings](https://app.clickup.com/settings/apps)
-2. Create a `.env` file:
-```env
-CLICKUP_API_KEY=your_api_key_here
-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!
 
-## Using with Cursor AI Composer Agent
-
-To add this server to Cursor AI Composer, follow these steps:
+## Features
 
-1. Go to the Features section in the settings.
-2. Add the following command under MCP Servers:
+- 🎯 **Task Management**
+  - Create, update, and delete individual tasks
+  - Move and duplicate tasks between lists, spaces, and folders
+  - Create multiple tasks in bulk
+  - View and modify task details and properties
 
-```bash
-npx -y @taazkareem/clickup-mcp-server --stdio \
-  --env CLICKUP_API_KEY=your_api_key_here \
-  --env TEAM_ID=your_team_id_here
-```
-3. Replace `your_api_key_here` and `your_team_id_here` with your actual ClickUp credentials.
-4. Click on 'Save' to add the server.
-
-> **Security Note**: Your API key will be stored securely and will not be exposed to AI models.
-
-### Available Tools
-
-1. **workspace_hierarchy**
-   - Lists complete hierarchy of the ClickUp workspace
-   - Shows spaces, folders, and lists with their IDs
-   - Shows available statuses for each list
-   - Provides a tree view of your workspace organization
-   - No parameters required
-
-2. **create_task**
-   - Creates a new task in ClickUp
-   - Required parameters:
-     - `name`: Name of the task
-   - Optional parameters:
-     - `listId`: ID of the list (optional if listName provided)
-     - `listName`: Name of the list (optional if listId provided)
-     - `description`: Task description
-     - `status`: Task status
-     - `priority`: Priority level (1-4)
-     - `dueDate`: Due date (ISO string)
-     - `assignees`: Array of user IDs
-
-3. **create_bulk_tasks**
-   - Creates multiple tasks simultaneously in a list
-   - Required parameters:
-     - `tasks`: Array of task objects, each containing:
-       - `name`: Name of the task (required)
-       - `description`: Task description (optional)
-       - `status`: Task status (optional)
-       - `priority`: Priority level 1-4 (optional)
-       - `dueDate`: Due date ISO string (optional)
-       - `assignees`: Array of user IDs (optional)
-   - Optional parameters:
-     - `listId`: ID of the list (optional if listName provided)
-     - `listName`: Name of the list (optional if listId provided)
-
-4. **create_list**
-   - Creates a new list in a space
-   - Required parameters:
-     - `name`: Name of the list
-   - Optional parameters:
-     - `spaceId`: ID of the space (optional if spaceName provided)
-     - `spaceName`: Name of the space (optional if spaceId provided)
-     - `content`: List description
-     - `status`: List status
-     - `priority`: Priority level (1-4)
-     - `dueDate`: Due date (ISO string)
-
-5. **create_folder**
-   - Creates a new folder in a space
-   - Required parameters:
-     - `name`: Name of the folder
-   - Optional parameters:
-     - `spaceId`: ID of the space (optional if spaceName provided)
-     - `spaceName`: Name of the space (optional if spaceId provided)
-     - `override_statuses`: Whether to override space statuses
-
-6. **create_list_in_folder**
-   - Creates a new list within a folder
-   - Required parameters:
-     - `name`: Name of the list
-   - Optional parameters:
-     - `folderId`: ID of the folder (optional if using folderName)
-     - `folderName`: Name of the folder
-     - `spaceId`: ID of the space (required if using folderName)
-     - `spaceName`: Name of the space (alternative to spaceId)
-     - `content`: List description
-     - `status`: List status
-
-7. **move_task**
-   - Moves a task to a different list
-   - Required parameters:
-     - `taskId`: ID of the task to move
-   - Optional parameters:
-     - `listId`: ID of destination list (optional if listName provided)
-     - `listName`: Name of destination list (optional if listId provided)
-
-8. **duplicate_task**
-   - Creates a copy of a task in a specified list
-   - Required parameters:
-     - `taskId`: ID of the task to duplicate
-   - Optional parameters:
-     - `listId`: ID of destination list (optional if listName provided)
-     - `listName`: Name of destination list (optional if listId provided)
-
-9. **update_task**
-   - Updates an existing task
-   - Required parameters:
-     - `taskId`: ID of the task to update
-   - Optional parameters:
-     - `name`: New task name
-     - `description`: New description
-     - `status`: New status
-     - `priority`: New priority level (1-4)
-     - `dueDate`: New due date (ISO string)
-
-### Available Prompts
-
-1. **summarize_tasks**
-   - Provides a comprehensive summary of tasks
-   - Groups tasks by status
-   - Highlights priorities and deadlines
-   - Suggests task relationships
-
-2. **analyze_priorities**
-   - Analyzes task priority distribution
-   - Identifies misaligned priorities
-   - Suggests priority adjustments
-   - Recommends task sequencing
-
-3. **generate_description**
-   - Helps generate detailed task descriptions
-   - Includes:
-     - Clear objectives
-     - Success criteria
-     - Required resources
-     - Dependencies
-     - Potential risks
-
-## Name Resolution
-
-Most tools support finding items by either ID or name:
-- Spaces can be referenced by `spaceId` or `spaceName`
-- Folders can be referenced by `folderId` or `folderName` (with space information)
-- Lists can be referenced by `listId` or found within spaces/folders
-
-Name matching is case-insensitive for convenience.
+- 📂 **Workspace Organization**
+  - Navigate complete workspace hierarchy (spaces, folders, lists)
+  - Tree structure with clear relationships
+  - Create and manage lists and folders
+  - Efficient path-based navigation
+
+- 🔄 **Integration Features**
+  - Name or ID-based item lookup
+  - Case-insensitive name matching
+  - Markdown formatting support
+  - Built-in API rate limiting
+  - Comprehensive error handling
+  - Clear parameter validation
+
+- 🤖 **AI-Powered Analysis**
+  - Task status summaries and overviews
+  - Priority analysis and recommendations
+  - Structured description generation
+  - Task relationship mapping
+  - Workspace organization insights
+
+## Available Tools
+
+| 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
+
+| 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
 
-The server provides clear error messages for common scenarios:
+The server provides clear error messages for:
 - Missing required parameters
 - Invalid IDs or names
 - Items not found
 - Permission issues
 - API errors
+- Rate limiting
 
-## Development
-
-1. Clone the repository:
-```bash
-git clone https://github.com/taazkareem/clickup-mcp-server.git
-cd clickup-mcp-server
-```
+## Support the Developer
 
-2. Install dependencies:
-```bash
-npm install
-```
+If you find this project useful, please consider supporting
 
-3. Start in development mode:
-```bash
-npm run dev
-```
+[![Sponsor TaazKareem](https://img.shields.io/badge/Sponsor-TaazKareem-orange?logo=github)](https://github.com/sponsors/TaazKareem)
 
 ## Contributing
 
@@ -238,3 +100,4 @@ Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md)
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

package/build/config.js

@@ -1,31 +1,19 @@
-import dotenv from 'dotenv';
-// Load environment variables from .env file
-dotenv.config();
-console.log('Environment variables received:', {
-    CLICKUP_API_KEY: process.env.CLICKUP_API_KEY,
-    TEAM_ID: process.env.TEAM_ID
-});
-// Parse command line arguments for --env flags
 const args = process.argv.slice(2);
-console.log('Command line arguments:', args);
 const envArgs = {};
 for (let i = 0; i < args.length; i++) {
     if (args[i] === '--env' && i + 1 < args.length) {
         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++;
     }
 }
-console.log('Parsed environment arguments:', envArgs);
 const configuration = {
     clickupApiKey: envArgs.clickupApiKey || process.env.CLICKUP_API_KEY || '',
-    teamId: envArgs.teamId || process.env.TEAM_ID || ''
+    clickupTeamId: envArgs.clickupTeamId || process.env.CLICKUP_TEAM_ID || '',
 };
-console.log('Final configuration:', configuration);
-// Check for missing environment variables
 const missingEnvVars = Object.entries(configuration)
     .filter(([_, value]) => !value)
     .map(([key]) => key);