How to integrate Habitica MCP with Pydantic AI

Trusted by
AWS
Glean
Zoom
Airtable
GET STARTED FOR FREEGET A DEMO

30 min · no commitment · see it on your stack

Habitica logo
Pydantic AI logo
divider

Introduction

This guide walks you through connecting Habitica to Pydantic AI using the Composio tool router. By the end, you'll have a working Habitica agent that can add a new daily task for exercise, create a challenge for team productivity, delete an outdated task from your challenge through natural language commands.

This guide will help you understand how to give your Pydantic AI agent real control over a Habitica account through Composio's Habitica MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Habitica with

TL;DR

Here's what you'll learn:
  • How to set up your Composio API key and User ID
  • How to create a Composio Tool Router session for Habitica
  • How to attach an MCP Server to a Pydantic AI agent
  • How to stream responses and maintain chat history
  • How to build a simple REPL-style chat interface to test your Habitica workflows

What is Pydantic AI?

Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications.

Key features include:

  • Type Safety: Built on Pydantic for automatic data validation
  • MCP Support: Native support for Model Context Protocol servers
  • Streaming: Built-in support for streaming responses
  • Async First: Designed for async/await patterns

What is the Habitica MCP server, and what's possible with it?

The Habitica MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Habitica account. It provides structured and secure access to your tasks, challenges, and groups, so your agent can create tasks, manage challenges, organize groups, and automate productivity routines on your behalf.

  • Automated task creation and management: Let your agent create new tasks, set up habits, or add to-dos to keep your productivity on track—no manual entry needed.
  • Challenge and group organization: Easily create, edit, or delete Habitica challenges and groups so you can coordinate goals and activities with teams or friends.
  • Tag and webhook automation: Have your agent generate new tags for smarter task sorting or set up webhooks for real-time notifications when tasks change or are completed.
  • Subscription and group membership management: Direct your agent to check or cancel subscriptions, leave parties, or delete groups as your needs change.
  • Seamless challenge task updates: Effortlessly add or remove tasks within challenges, helping you keep group goals relevant and up to date.

Supported Tools & Triggers

Tools
Add Task to ChallengeTool to add a new task to a specified challenge.
Add Push DeviceTool to register a push notification device for the authenticated user.
Add Tag to TaskTool to add a tag to a task.
Clone ChallengeTool to clone an existing challenge.
Create ChallengeTool to create a new challenge.
Create Habitica PartyCreate a new Habitica party for collaborative gameplay.
Create TagTool to create a new tag.
Create TaskCreate a new task in Habitica.
Create WebhookTool to create a new webhook for taskActivity events.
Delete Habitica ChallengePermanently delete a Habitica challenge.
Leave or Delete Habitica GroupLeave or delete a Habitica group (party or guild).
Delete Group Chat MessageTool to delete a chat message from a Habitica group (party, guild, or Tavern).
Delete Habitica TagTool to delete a tag for the authenticated user.
Delete TaskPermanently deletes a user's task (habit, daily, todo, or reward) by its ID.
Delete Task Checklist ItemTool to delete a checklist item from a task.
Delete User MessageTool to delete a message from the authenticated user's inbox by its ID.
Delete User Push DeviceTool to remove a push device registration from the authenticated user's account.
Equip ItemTool to equip or unequip gear, pets, mounts, or costume items in Habitica.
Export Challenge to CSVTool to export a Habitica challenge to CSV format.
Get ChallengeTool to retrieve details of a specific challenge.
Get Group ChallengesTool to retrieve challenges available in a specific group (guild, party, or tavern).
Get Task by IDRetrieve a task by its unique ID.
Get Challenge TasksTool to get all tasks for a specified challenge.
Get ContentRetrieves all Habitica game content definitions in a single request.
Get Content By TypeRetrieves Habitica game content data filtered by a specific category type.
Get Export History CSVTool to export user tasks history in CSV format.
Get Export Inbox HTMLTool to export inbox data in HTML format from Habitica.
Export User Data JSONExports the authenticated user's complete data in JSON format.
Get GroupRetrieves detailed information about a Habitica group (guild or party).
Get Group MembersRetrieve members of a Habitica group (guild or party).
Get Habitica GroupsRetrieves Habitica groups based on type.
Get Habitica Tavern GroupTool to retrieve the Habitica Tavern (habitrpg) group details.
Get Party Chat MessagesTool to retrieve party chat messages from Habitica.
Get Model PathsRetrieves all available field paths and their data types for a specified Habitica model.
Get NewsTool to retrieve the latest Bailey announcement from Habitica.
Get PartyRetrieves the authenticated user's party details from Habitica.
Get Shops Market GearTool to retrieve the available gear for purchase in the market shop.
Get Time Travelers ShopTool to retrieve available items in the Time Travelers shop.
Get Habitica API StatusTool to check Habitica API server status.
Get TagsRetrieve all tags for the authenticated Habitica user.
Get TasksTool to retrieve all tasks for the authenticated user.
Get User ChallengesTool to retrieve challenges the authenticated user participates in.
Get User ProfileRetrieves the authenticated user's complete Habitica profile.
Get WebhooksRetrieves all webhooks configured for the authenticated Habitica user.
Get World StateRetrieves the current state of the Habitica game world including active events, world boss status, and seasonal NPC visual themes.
Invite To GroupTool to invite users to a specific group.
Invite To QuestTool to invite party members to a quest.
Join ChallengeTool to join a challenge.
Leave ChallengeTool to leave a Habitica challenge.
Local LoginTool to authenticate a user via local credentials.
Local User RegistrationTool to register a new Habitica user via email and password.
Mark Group Chat SeenTool to mark all chat messages as read/seen for a specific group.
Mark Notification SeenTool to mark a single notification as seen in Habitica.
Mark Notifications SeenMarks specific notifications as read/seen in Habitica.
Move Pinned ItemTool to move a pinned item in the rewards column to a new position.
Move Task To PositionMove a Habitica task to a new position in the task list.
Dismiss Bailey AnnouncementTool to dismiss the latest Bailey announcement in Habitica, allowing it to be read later.
Reset User AccountResets the authenticated user's account to starting state.
Read CardTool to mark a card as read in Habitica.
Remove Party MemberRemoves a member from the authenticated user's party.
Score TaskScore a Habitica task to mark it as completed or incomplete.
Social AuthTool to authenticate a user via a social provider.
Subscribe WebhookTool to enable (subscribe) an existing webhook by ID for the authenticated user.
Unlink All Challenge TasksTool to unlink all tasks from a Habitica challenge.
Update GroupTool to update a Habitica group (party or guild) by modifying its properties.
Update TagTool to update an existing tag's name.
Update TaskUpdate an existing task in Habitica.
Update Task Checklist ItemTool to update a checklist item in a task.
Update UserUpdate the authenticated user's profile, preferences, flags, and other settings in Habitica.
Validate Coupon CodeValidate a Habitica coupon code to check if it is valid and active.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Prerequisites

Before starting, make sure you have:
  • Python 3.9 or higher
  • A Composio account with an active API key
  • Basic familiarity with Python and async programming

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.

Install dependencies

bash
pip install composio pydantic-ai python-dotenv

Install the required libraries.

What's happening:

  • composio connects your agent to external SaaS tools like Habitica
  • pydantic-ai lets you create structured AI agents with tool support
  • python-dotenv loads your environment variables securely from a .env file

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your agent to Composio's API
  • USER_ID associates your session with your account for secure tool access
  • OPENAI_API_KEY to access OpenAI LLMs

Import dependencies

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()
What's happening:
  • We load environment variables and import required modules
  • Composio manages connections to Habitica
  • MCPServerStreamableHTTP connects to the Habitica MCP server endpoint
  • Agent from Pydantic AI lets you define and run the AI assistant

Create a Tool Router Session

python
async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Habitica
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["habitica"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")
What's happening:
  • We're creating a Tool Router session that gives your agent access to Habitica tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned session.mcp.url is the MCP server URL that your agent will use

Initialize the Pydantic AI Agent

python
# Attach the MCP server to a Pydantic AI Agent
habitica_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
agent = Agent(
    "openai:gpt-5",
    toolsets=[habitica_mcp],
    instructions=(
        "You are a Habitica assistant. Use Habitica tools to help users "
        "with their requests. Ask clarifying questions when needed."
    ),
)
What's happening:
  • The MCP client connects to the Habitica endpoint
  • The agent uses GPT-5 to interpret user commands and perform Habitica operations
  • The instructions field defines the agent's role and behavior

Build the chat interface

python
# Simple REPL with message history
history = []
print("Chat started! Type 'exit' or 'quit' to end.\n")
print("Try asking the agent to help you with Habitica.\n")

while True:
    user_input = input("You: ").strip()
    if user_input.lower() in {"exit", "quit", "bye"}:
        print("\nGoodbye!")
        break
    if not user_input:
        continue

    print("\nAgent is thinking...\n", flush=True)

    async with agent.run_stream(user_input, message_history=history) as stream_result:
        collected_text = ""
        async for chunk in stream_result.stream_output():
            text_piece = None
            if isinstance(chunk, str):
                text_piece = chunk
            elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                text_piece = chunk.delta
            elif hasattr(chunk, "text"):
                text_piece = chunk.text
            if text_piece:
                collected_text += text_piece
        result = stream_result

    print(f"Agent: {collected_text}\n")
    history = result.all_messages()
What's happening:
  • The agent reads input from the terminal and streams its response
  • Habitica API calls happen automatically under the hood
  • The model keeps conversation history to maintain context across turns

Run the application

python
if __name__ == "__main__":
    asyncio.run(main())
What's happening:
  • The asyncio loop launches the agent and keeps it running until you exit

Complete Code

Here's the complete code to get you started with Habitica and Pydantic AI:

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()

async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Habitica
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["habitica"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")

    # Attach the MCP server to a Pydantic AI Agent
    habitica_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[habitica_mcp],
        instructions=(
            "You are a Habitica assistant. Use Habitica tools to help users "
            "with their requests. Ask clarifying questions when needed."
        ),
    )

    # Simple REPL with message history
    history = []
    print("Chat started! Type 'exit' or 'quit' to end.\n")
    print("Try asking the agent to help you with Habitica.\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "bye"}:
            print("\nGoodbye!")
            break
        if not user_input:
            continue

        print("\nAgent is thinking...\n", flush=True)

        async with agent.run_stream(user_input, message_history=history) as stream_result:
            collected_text = ""
            async for chunk in stream_result.stream_output():
                text_piece = None
                if isinstance(chunk, str):
                    text_piece = chunk
                elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                    text_piece = chunk.delta
                elif hasattr(chunk, "text"):
                    text_piece = chunk.text
                if text_piece:
                    collected_text += text_piece
            result = stream_result

        print(f"Agent: {collected_text}\n")
        history = result.all_messages()

if __name__ == "__main__":
    asyncio.run(main())

Conclusion

You've built a Pydantic AI agent that can interact with Habitica through Composio's Tool Router. With this setup, your agent can perform real Habitica actions through natural language. You can extend this further by:
  • Adding other toolkits like Gmail, HubSpot, or Salesforce
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Habitica for workflow automation)
This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations.

How to build Habitica MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Habitica MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Habitica MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Habitica MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Habitica MCP with Claude Cowork

Codex logo

Codex

Use Habitica MCP with Codex

OpenClaw logo

OpenClaw

Use Habitica MCP with OpenClaw

Hermes logo

Hermes

Use Habitica MCP with Hermes

CLI logo

CLI

Use Habitica MCP with CLI

Google ADK logo

Google ADK

Use Habitica MCP with Google ADK

LangChain logo

LangChain

Use Habitica MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Habitica MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Habitica MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Habitica MCP with LlamaIndex

CrewAI logo

CrewAI

Use Habitica MCP with CrewAI

FAQ

What are the differences in Tool Router MCP and Habitica MCP?

With a standalone Habitica MCP server, the agents and LLMs can only access a fixed set of Habitica tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Habitica and many other apps based on the task at hand, all through a single MCP endpoint.

Can I use Tool Router MCP with Pydantic AI?

Yes, you can. Pydantic AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Habitica tools.

Can I manage the permissions and scopes for Habitica while using Tool Router?

Yes, absolutely. You can configure which Habitica scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Habitica data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Get started for freeGet a demo↗