Skip to main content

MCP server for Habitica task and tag management

Project description

mcp-habitica

A Model Context Protocol (MCP) server for Habitica - enabling Claude to manage your tasks and tags.

Features

This MCP server provides tools for managing Habitica tasks and tags:

Task Operations

  • get_tasks - Get all tasks or filter by type (habits, dailys, todos, rewards)
  • get_task - Get a specific task by ID
  • create_task - Create a new task with title, notes, tags, and priority
  • update_task - Update an existing task
  • delete_task - Delete a task
  • score_task - Mark a task as complete or failed

Tag Operations

  • get_tags - Get all tags
  • get_tag - Get a specific tag by ID
  • create_tag - Create a new tag
  • update_tag - Update a tag name
  • delete_tag - Delete a tag

Installation

Using uv (recommended)

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install the package
uvx mcp-habitica

Using pip

pip install mcp-habitica

Configuration

1. Get Your Habitica API Credentials

  1. Log in to Habitica
  2. Go to Settings > Site Data
  3. Copy your User ID and API Token

2. Configure Environment Variables

Set the following environment variables:

export HABITICA_USER_ID="your-user-id"
export HABITICA_API_TOKEN="your-api-token"
export HABITICA_CLIENT_ID="your-user-id-mcp-habitica"  # Optional

3. Configure Claude Desktop

Add this to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "habitica": {
      "command": "uv",
      "args": ["mcp-habitica"],
      "env": {
        "HABITICA_USER_ID": "your-user-id",
        "HABITICA_API_TOKEN": "your-api-token"
      }
    }
  }
}

to run locally

{
  "mcpServers": {
    "mcp-habitica": {
      "command": "uv",
      "args": [
        "--directory",
        "<repo-folder>/mcp-habitica",
        "run",
        "mcp-habitica"
      ],
      "env": {
        "HABITICA_USER_ID": "your-user-id",
        "HABITICA_API_TOKEN": "your-api-token"
      }
    }
  }
}

Usage Examples

Once configured, you can ask Claude to manage your Habitica tasks:

  • "Show me all my todos"
  • "Create a todo: Finish the project report"
  • "Mark task [task-id] as complete"
  • "Create a tag called 'work'"
  • "Show all my tags"

API Reference

For detailed API documentation, visit the Habitica API Documentation.

Task Types

  • habit - Habits (positive/negative)
  • daily - Daily tasks
  • todo - To-dos
  • reward - Rewards

Task Priority Levels

  • 0.1 - Trivial
  • 1.0 - Easy (default)
  • 1.5 - Medium
  • 2.0 - Hard

Development

Setup

# Clone the repository
git clone https://github.com/yourusername/mcp-habitica.git
cd mcp-habitica

# Install dependencies
uv sync

# Run tests (when available)
uv run pytest

Project Structure

mcp-habitica/
├── src/
│   └── mcp_habitica/
│       ├── __init__.py
│       ├── habitica_client.py  # Habitica API client
│       └── server.py            # MCP server implementation
├── pyproject.toml
├── README.md
└── LICENSE

Publishing

For Maintainers

To publish a new version to PyPI:

Quick way:

./scripts/publish.sh

Manual way: See PUBLISH.md for detailed instructions.

Super quick: See QUICKSTART.md for TL;DR.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

Acknowledgments

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

mcp_habitica-0.2.2.tar.gz (59.4 kB view details)

Uploaded Source

Built Distribution

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

mcp_habitica-0.2.2-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file mcp_habitica-0.2.2.tar.gz.

File metadata

  • Download URL: mcp_habitica-0.2.2.tar.gz
  • Upload date:
  • Size: 59.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for mcp_habitica-0.2.2.tar.gz
Algorithm Hash digest
SHA256 819f104d9c4f94024fe8d8ad5f6f5a617823abd1df72c26b4c6949aa50b4ca42
MD5 417b0a85fd93b4ef3fdc40b6a2083aba
BLAKE2b-256 cfeceb2a23758a8afcb437449e36925ecf1107883a8bba98780fccc3fbc2f837

See more details on using hashes here.

File details

Details for the file mcp_habitica-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: mcp_habitica-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for mcp_habitica-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ab58370487c6a0c30a2b1f057eb0a59bfbaaabf1867f9060dba287404ec05b13
MD5 1acfc77a8c082d967e3d74cc3076339d
BLAKE2b-256 a8187427424b4c1d65e9e746a4469a6da813c12c87ce9db2edf1ae5d085c1822

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