> ## Documentation Index
> Fetch the complete documentation index at: https://phidatainc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickUp Tools

> List ClickUp spaces and manage tasks with ClickUpTools using CLICKUP_API_KEY and MASTER_SPACE_ID.

Step 1: Log In to ClickUp Step 2: Navigate to Settings (usually a circle with your initials) click on it Step 3: Access the Apps Section: In the settings sidebar on the left, scroll down until you find Apps. Click on it to access the API settings. Step 4: Generate Your API Key In the Apps section, you should see an option labeled API Key. If it’s not already generated, look for a button that says Generate and click it. Once generated, your API key will be displayed. Make sure to copy this key and store it as CLICKUP\_API\_KEY in .env file to use it.

```python clickup_tools.py theme={null}
"""
Steps to Get Your ClickUp API Key

Step 1: Log In to ClickUp
Step 2: Navigate to Settings (usually a circle with your initials) click on it
Step 3: Access the Apps Section: In the settings sidebar on the left, scroll down until you find Apps. Click on it to access the API settings.
Step 4: Generate Your API Key
In the Apps section, you should see an option labeled API Key. If it’s not already generated, look for a button that says Generate and click it.
Once generated, your API key will be displayed. Make sure to copy this key and store it as CLICKUP_API_KEY in .env file to use it.

Steps To find your MASTER_SPACE_ID :
clickup space url structure: https://app.clickup.com/{MASTER_SPACE_ID}/v/o/s/{SPACE_ID}
1. copy any space url from your clickup workspace all follow above url structure.
2. To use clickup tool copy the MASTER_SPACE_ID and store it .env file.

"""

from agno.agent import Agent
from agno.models.openai import OpenAIChat
from agno.tools.clickup import ClickUpTools

# ---------------------------------------------------------------------------
# Create Agent
# ---------------------------------------------------------------------------


clickup_agent = Agent(
    name="ClickUp Agent",
    role="Manage ClickUp tasks and spaces",
    model=OpenAIChat(id="gpt-5.2"),
    tools=[
        ClickUpTools(
            exclude_tools=[
                "create_task",
                "get_task",
                "update_task",
                "delete_task",
            ]
        )
    ],
    instructions=[
        "You are a ClickUp assistant that helps users manage their tasks and spaces.",
        "You can:",
        "1. List all available spaces",
        "2. List tasks from a specific space",
        "3. List all lists in a space",
        "4. Create new tasks with title, description, and status",
        "When creating tasks:",
        "- Always get space name, task name, and description",
        "- Status can be: todo, in progress, or done",
        "- If status is not specified, use 'todo' as default",
        "Be helpful and guide users if they need more information.",
    ],
    markdown=True,
)

# ---------------------------------------------------------------------------
# Run Agent
# ---------------------------------------------------------------------------
if __name__ == "__main__":
    clickup_agent.print_response(
        "List all spaces i have",
        markdown=True,
    )
    clickup_agent.print_response(
        "Create a task (status 'To Do') called 'QA task' in Project 1 in the Team Space. The description should be about running basic QA checks on our Python codebase.",
        markdown=True,
    )
```

## Run the Example

<Steps>
  <Snippet file="create-venv-step.mdx" />

  <Step title="Install dependencies">
    ```bash theme={null}
    uv pip install -U agno openai requests
    ```
  </Step>

  <Step title="Export environment variables">
    <CodeGroup>
      ```bash Mac/Linux theme={null}
      export CLICKUP_API_KEY="your_clickup_api_key_here"
      export MASTER_SPACE_ID="your_master_space_id_here"
      export OPENAI_API_KEY="your_openai_api_key_here"
      ```

      ```bash Windows theme={null}
      $Env:CLICKUP_API_KEY="your_clickup_api_key_here"
      $Env:MASTER_SPACE_ID="your_master_space_id_here"
      $Env:OPENAI_API_KEY="your_openai_api_key_here"
      ```
    </CodeGroup>
  </Step>

  <Step title="Run the example">
    Save the code above as `clickup_tools.py`, then run:

    ```bash theme={null}
    python clickup_tools.py
    ```
  </Step>
</Steps>

Full source: [cookbook/91\_tools/clickup\_tools.py](https://github.com/agno-agi/agno/blob/main/cookbook/91_tools/clickup_tools.py)
