How to integrate Habitica MCP with OpenAI Agents SDK

BOOK A CALLGET STARTED FOR FREE
Framework Integration Gradient
Habitica Logo
open-ai-agents-sdk Logo
divider

Introduction

This guide walks you through connecting Habitica to the OpenAI Agents SDK 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 my challenge, create a tag for urgent work tasks through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK 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.

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Habitica
  • Configure an AI agent that can use Habitica as a tool
  • Run a live chat session where you can ask the agent to perform Habitica operations

What is open-ai-agents-sdk?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

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.
Cancel SubscriptionAttempts to cancel the authenticated user's subscription.
Create ChallengeTool to create a new challenge.
Create Habitica GroupTool to create a Habitica party or guild.
Create TagTool to create a new tag.
Create TaskTool to create a new user task in Habitica.
Create WebhookTool to create a new webhook for taskActivity events.
Delete a Habitica ChallengeTool to delete a challenge.
Delete Challenge TaskTool to delete a specific task from a challenge.
Delete Habitica GroupTool to delete a Habitica group (guild) or leave a party.
Delete Habitica TagTool to delete a tag for the authenticated user.
Delete TaskTool to delete a Habitica task.
Get Habitica AchievementsTool to retrieve all available Habitica achievements.
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 Challenge TaskTool to retrieve a specific task from any challenge.
Get Challenge TasksTool to get all tasks for a specified challenge.
Get ContentTool to retrieve global game content definitions.
Get Content By TypeTool to retrieve game content for a specified category.
Get EquipmentTool to retrieve the authenticated user’s equipped gear and costume.
Get GroupTool to retrieve details of a specific group.
Get Group MembersTool to retrieve members of a specific group.
Get Habitica GroupsTool to retrieve Habitica groups (guilds, parties, taverns).
Get NotificationsTool to retrieve notifications for the authenticated user.
Get PartyTool to retrieve the authenticated user's party details.
Get Party MembersTool to retrieve members of the authenticated user's party.
Get TagsTool to retrieve authenticated user's tags.
Get TasksTool to retrieve all tasks for the authenticated user.
Get User AchievementsTool to retrieve the authenticated user's achievements.
Get User ChallengesTool to retrieve challenges the authenticated user participates in.
Get User InventoryTool to retrieve the authenticated user's full inventory.
Get User ProfileTool to retrieve the authenticated user's profile information.
Get User Quest ProgressTool to retrieve the authenticated user's quest progress.
Get User StatsTool to retrieve the authenticated user's Habitica statistics.
Get User SubscriptionTool to retrieve the authenticated user's subscription details.
Get WebhooksTool to retrieve webhooks for the authenticated user.
Invite To GroupTool to invite users to a specific group.
Invite To PartyTool to invite users to the authenticated user's party.
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 Notifications SeenTool to mark specific notifications as read.
Remove Party MemberTool to remove a member from your party.
Score TaskTool to score (check/uncheck) a Habitica task.
Social AuthTool to authenticate a user via a social provider.
Subscribe WebhookTool to enable (subscribe) an existing webhook by ID for the authenticated user.

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

What is Tool Router?

Composio's Tool Router 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 Tool Router

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

How the Tool Router works

The Tool Router 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:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Habitica project
  • Some knowledge of Python or Typescript

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

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Habitica.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Habitica Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["habitica"]
)

mcp_url = session.mcp.url

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only habitica.
  • The router checks the user's Habitica connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Habitica.
  • This approach keeps things lightweight and lets the agent request Habitica tools only when needed during the conversation.

Configure the agent

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Habitica. "
        "Help users perform Habitica operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Habitica and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a HostedMCPTool that connects to the MCP server URL we created earlier.
  • The headers dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Habitica operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
What's happening:
  • The program prints a session URL that you visit to authorize Habitica.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Habitica and open-ai-agents-sdk:

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["habitica"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Habitica. "
        "Help users perform Habitica operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

Conclusion

This was a starter code for integrating Habitica MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Habitica.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.

How to build Habitica MCP Agent with another framework

Claude Agent SDK

Claude Agent SDK

Use Habitica MCP with Claude Agent SDK

Google ADK

Google ADK

Use Habitica MCP with Google ADK

LangChain

LangChain

Use Habitica MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Habitica MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use Habitica MCP with Mastra AI

LlamaIndex

LlamaIndex

Use Habitica MCP with LlamaIndex

CrewAI

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 OpenAI Agents SDK?

Yes, you can. OpenAI Agents SDK 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
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
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.

Book a call↗Get started for free