Skip to main content

Model Context Protocol server for Goodday project management platform

Project description

Goodday MCP Server

A Model Context Protocol (MCP) server for integrating with Goodday project management platform. This server provides tools for managing projects, tasks, and users through the Goodday API v2.

Features

Project Management

  • get_projects: Retrieve list of projects (with options for archived and root-only filtering)
  • get_project: Get detailed information about a specific project
  • create_project: Create new projects with customizable templates and settings
  • get_project_users: Get users associated with a specific project

Task Management

  • get_project_tasks: Retrieve tasks from specific projects (with options for closed tasks and subfolders)
  • get_user_assigned_tasks: Get tasks assigned to a specific user
  • get_user_action_required_tasks: Get action-required tasks for a user
  • get_task: Get detailed information about a specific task
  • create_task: Create new tasks with full customization (subtasks, assignments, dates, priorities)
  • update_task_status: Update task status with optional comments
  • add_task_comment: Add comments to tasks

User Management

  • get_users: Retrieve list of organization users
  • get_user: Get detailed information about a specific user

Installation

From PyPI (Recommended)

pip install goodday-mcp

From Source

Prerequisites

  • Python 3.10 or higher
  • UV package manager (recommended) or pip
  • Goodday API token

Setup with UV

  1. Install UV (if not already installed):

    curl -LsSf https://astral.sh/uv/install.sh | sh
    
  2. Clone and set up the project:

    git clone https://github.com/yourusername/goodday-mcp.git
    cd goodday-mcp
    
    # Create virtual environment and install dependencies
    uv venv
    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
    uv sync
    

Setup with pip

git clone https://github.com/yourusername/goodday-mcp.git
cd goodday-mcp
pip install -e .

Configuration

  1. Set up environment variables: Create a .env file in your project root or export the variable:

    export GOODDAY_API_TOKEN=your_goodday_api_token_here
    

    To get your Goodday API token:

    • Go to your Goodday organization
    • Navigate to Settings → API
    • Click the generate button to create a new token

Usage

Running the Server Standalone

If installed from PyPI:

goodday-mcp

If running from source with UV:

uv run goodday-mcp

Using with Claude Desktop

  1. Configure Claude Desktop by editing your configuration file:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  2. Add the server configuration:

    Option A: If installed from PyPI:

    {
      "mcpServers": {
        "goodday": {
          "command": "goodday-mcp",
          "env": {
            "GOODDAY_API_TOKEN": "your_goodday_api_token_here"
          }
        }
      }
    }
    

    Option B: If running from source:

    {
      "mcpServers": {
        "goodday": {
          "command": "uv",
          "args": ["run", "goodday-mcp"],
          "env": {
            "GOODDAY_API_TOKEN": "your_goodday_api_token_here"
          }
        }
      }
    }
    
  3. Restart Claude Desktop to load the new server.

Using with Other MCP Clients

The server communicates via stdio transport and can be integrated with any MCP-compatible client. Refer to the MCP documentation for client-specific integration instructions.

API Reference

Environment Variables

Variable Description Required
GOODDAY_API_TOKEN Your Goodday API token Yes

Tool Examples

Get Projects

# Get all active projects
get_projects()

# Get archived projects
get_projects(archived=True)

# Get only root-level projects
get_projects(root_only=True)

Create a Task

create_task(
    project_id="project_123",
    title="Implement new feature",
    from_user_id="user_456",
    message="Detailed description of the task",
    to_user_id="user_789",
    deadline="2025-06-30",
    priority=5
)

Update Task Status

update_task_status(
    task_id="task_123",
    user_id="user_456",
    status_id="status_completed",
    message="Task completed successfully"
)

Data Formats

Date Format

All dates should be provided in YYYY-MM-DD format (e.g., 2025-06-16).

Priority Levels

  • 1-10: Normal priority levels
  • 50: Blocker
  • 100: Emergency

Project Colors

Project colors are specified as integers from 1-24, corresponding to Goodday's color palette.

Error Handling

The server includes comprehensive error handling:

  • Authentication errors: When API token is missing or invalid
  • Network errors: When Goodday API is unreachable
  • Validation errors: When required parameters are missing
  • Permission errors: When user lacks permissions for requested operations

All errors are returned as descriptive strings to help with troubleshooting.

Development

Project Structure

goodday-mcp/
├── goodday_mcp/         # Main package directory
│   ├── __init__.py      # Package initialization
│   └── main.py          # Main MCP server implementation
├── pyproject.toml       # Project configuration and dependencies
├── README.md           # This file
├── LICENSE             # MIT license
├── uv.lock            # Dependency lock file
└── .env               # Environment variables (create this)

Adding New Tools

To add new tools to the server:

  1. Add the tool function in goodday_mcp/main.py using the @mcp.tool() decorator:

    @mcp.tool()
    async def your_new_tool(param1: str, param2: Optional[int] = None) -> str:
        """Description of what the tool does.
        
        Args:
            param1: Description of parameter 1
            param2: Description of optional parameter 2
        """
        # Implementation here
        return "Result"
    
  2. Test the tool by running the server and testing with an MCP client.

Testing

Test the server by running it directly:

# If installed from PyPI
goodday-mcp

# If running from source
uv run goodday-mcp

The server will start and wait for MCP protocol messages via stdin/stdout.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For issues related to:

Changelog

v1.0.0

  • Initial release
  • Full project management capabilities
  • Task management with comments and status updates
  • User management
  • Comprehensive error handling
  • UV support with modern Python packaging

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

goodday_mcp-1.0.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

goodday_mcp-1.0.1-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file goodday_mcp-1.0.1.tar.gz.

File metadata

  • Download URL: goodday_mcp-1.0.1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.9

File hashes

Hashes for goodday_mcp-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f345f91083afbd6fcf99ab6879f1008555201453cdea0cddb2d4b2465d4eb333
MD5 af94758484febf4c80ea725d47e2e34c
BLAKE2b-256 6b65bb02628d77c80317dc940799b3ed5f9c751c12975466f4c2607f7908dc7d

See more details on using hashes here.

File details

Details for the file goodday_mcp-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for goodday_mcp-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 934998c965d71fd6726511d53b62609ad7e3212722d2248aebbadf82c35f748d
MD5 6a247e2bb6ce2b36194fa8b55fe493de
BLAKE2b-256 fca0991c3cb7eb6fe57e2feef59b0f37edc27c344cacac61d01f6889cf2394b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page