Development Requirements

Before you begin contributing to ClickUp MCP Server, ensure your development environment meets these requirements.

Software Prerequisites

Required Software

• Python: Python 3.13 or higher
• Git: Latest stable version
• pip, poetry or uv: Latest version
• virtualenv or pyenv: For creating isolated Python environments

Recommended Development Tools

• Visual Studio Code, PyCharm, or other IDE with Python support
• pre-commit: For running pre-commit hooks
• Docker: For containerized testing and deployment

Python Dependencies

The project has several dependencies that will be installed automatically when you set up the development environment:

• FastAPI: Web framework for API endpoints
• Pydantic: Data validation and settings management
• httpx: HTTP client for async requests
• pytest: Testing framework
• python-dotenv: Environment variable management
• uvicorn: ASGI server for running the application

Development Environment Setup

1. Clone the repository:

   git clone https://github.com/Chisanan232/clickup-mcp-server.git
   cd clickup-mcp-server

2. Create a virtual environment:

   virtualenv

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

   conda

   conda create -n clickup-mcp python=3.13
   conda activate clickup-mcp

   poetry

   poetry shell

   uv

   uv venv
   source .venv/bin/activate

3. Install development dependencies:

   pip

   pip install -e ".[dev]"

   poetry

   poetry install --with=dev

   uv

   uv pip install .

4. Set up pre-commit hooks:

   pip

   pre-commit install

   poetry

   poetry run pre-commit install

   uv

   uv run pre-commit install

5. Create a .env file for local development:

   cp .env.example .env
   # Edit .env with your ClickUp API token

Next Steps

Once your development environment is set up, refer to the Development Workflow documentation for the next steps.