ClickUp MCP server

This MCP server implementation enables you to run ClickUp integration through Supergateway, providing an SSE (Server-Sent Events) endpoint that can be used with n8n nodes or other compatible clients. It offers a seamless way to connect to ClickUp services while handling the underlying communication protocols.

Installation Options

Local Installation with Node.js

1. Install the required packages globally:

npm install -g supergateway @taazkareem/clickup-mcp-server

2. Set your ClickUp credentials as environment variables:

export CLICKUP_API_KEY=your_api_key_here
export CLICKUP_TEAM_ID=your_team_id_here

3. Run the integration script:

./run-clickup-mcp.sh

4. For custom configuration, you can specify additional parameters:

./run-clickup-mcp.sh --port 9000 --base-url http://example.com --cors "http://localhost:8080,http://localhost:3000"

Docker Compose Installation

1. Create an environment file by copying the example:

cp .env.example .env

2. Edit the .env file to include your ClickUp credentials.

3. Start the Docker container:

docker-compose up -d

4. Monitor the logs if needed:

docker-compose logs -f

Railway Deployment

1. Create a new project on Railway platform.

2. Connect your GitHub repository or deploy using the Railway CLI.

3. Configure the following environment variables:

   • CLICKUP_API_KEY: Your ClickUp API key
   • CLICKUP_TEAM_ID: Your ClickUp Team ID
   • PORT: 8000 (or preferred port)
   • BASE_URL: Your Railway app URL
   • SSE_PATH: /sse (or preferred path)
   • MESSAGE_PATH: /message (or preferred path)
   • LOG_LEVEL: info (or debug)
   • DOCUMENT_SUPPORT: false (or true if needed)
   • CORS_ORIGINS: * (or specific allowed origins)

4. Deploy your application through the Railway platform.

Usage Guide

Configuring with n8n

1. In your n8n workflow, add a new "MCP" node.

2. Configure the node with these settings:

   • Server URL: Your server URL + SSE path (e.g., https://your-app-name.up.railway.app/sse)
   • Message Path: Your message path (e.g., /message)

3. Select the appropriate ClickUp tool from the available options.

4. Set the required parameters for your selected tool.

5. Connect the node to other parts of your workflow.

Available API Endpoints

The server exposes three main endpoints:

• SSE Endpoint ({BASE_URL}{SSE_PATH}):

  • Method: GET
  • Purpose: Subscribe to server-sent events

• Message Endpoint ({BASE_URL}{MESSAGE_PATH}):

  • Method: POST
  • Content-Type: application/json
  • Body format: JSON-RPC 2.0
  • Purpose: Send messages to the server

• Health Check ({BASE_URL}/healthz):

  • Method: GET
  • Response: "ok" when healthy
  • Purpose: Verify service status

Troubleshooting

If you encounter issues with your MCP server:

• Connection Problems: Check if your firewall allows connections on the configured port
• Authentication Failures: Verify your ClickUp API key and Team ID are entered correctly
• CORS Issues: Ensure the CORS_ORIGINS environment variable includes your client's origin

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.