How to integrate Habitica MCP with LlamaIndex

This guide walks you through connecting Habitica to LlamaIndex 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 LlamaIndex 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.

Get started for freeGet a demo
Habitica logoHabitica
Api Key

Habitica is an open-source task manager that gamifies your to-do lists and daily habits. Level up your productivity by turning tasks into an engaging RPG experience.

70 Tools

Introduction

This guide walks you through connecting Habitica to LlamaIndex 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 LlamaIndex 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

OpenAI Agents SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AICrewAI

TL;DR

Here's what you'll learn:
  • Set your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for Habitica
  • Connect LlamaIndex to the Habitica MCP server
  • Build a Habitica-powered agent using LlamaIndex
  • Interact with Habitica through natural language

What is LlamaIndex?

LlamaIndex is a data framework for building LLM applications. It provides tools for connecting LLMs to external data sources and services through agents and tools.

Key features include:

  • ReAct Agent: Reasoning and acting pattern for tool-using agents
  • MCP Tools: Native support for Model Context Protocol
  • Context Management: Maintain conversation context across interactions
  • Async Support: Built 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.

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

Step by step10 STEPS
1

Prerequisites

Before you begin, make sure you have:
  • Python 3.8/Node 16 or higher installed
  • A Composio account with the API key
  • An OpenAI API key
  • A Habitica account and project
  • Basic familiarity with async Python/Typescript
2

Getting API Keys for OpenAI, Composio, and Habitica

OpenAI API key (OPENAI_API_KEY)
  • Go to the OpenAI dashboard
  • Create an API key if you don't have one
  • Assign it to OPENAI_API_KEY in .env
Composio API key and user ID
  • Log into the Composio dashboard
  • Copy your API key from Settings
    • Use this as COMPOSIO_API_KEY
  • Pick a stable user identifier (email or ID)
    • Use this as COMPOSIO_USER_ID
3

Installing dependencies

npm install @composio/llamaindex @llamaindex/openai @llamaindex/tools @llamaindex/workflow dotenv

Create a new Typescript project and install the necessary dependencies:

  • @composio/llamaindex: Composio's LlamaIndex integration
  • @llamaindex/openai: OpenAI LLM integration
  • @llamaindex/tools: MCP client for LlamaIndex
  • @llamaindex/workflow: Workflow framework for LlamaIndex
  • dotenv: Environment variable management
4

Set environment variables

bash
OPENAI_API_KEY=your-openai-api-key
COMPOSIO_API_KEY=your-composio-api-key
COMPOSIO_USER_ID=your-user-id

Create a .env file in your project root:

These credentials will be used to:

  • Authenticate with OpenAI's GPT-5 model
  • Connect to Composio's Tool Router
  • Identify your Composio user session for Habitica access
5

Import modules

import "dotenv/config";
import readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";

import { Composio } from "@composio/core";

import { mcp } from "@llamaindex/tools";
import { agent as createAgent } from "@llamaindex/workflow";
import { openai } from "@llamaindex/openai";

dotenv.config();

Create a new file called habitica_llamaindex_agent.ts and import the required modules:

Key imports:

  • dotenv.config loads .env at runtime
  • readline gives us a simple CLI chat loop
  • Composio is the main Composio SDK client
  • mcp connects to an MCP endpoint
  • createAgent builds a LlamaIndex agent
  • openai configures the LLM backend
6

Load environment variables and initialize Composio

const OPENAI_API_KEY = process.env.OPENAI_API_KEY;
const COMPOSIO_API_KEY = process.env.COMPOSIO_API_KEY;
const COMPOSIO_USER_ID = process.env.COMPOSIO_USER_ID;

if (!OPENAI_API_KEY) throw new Error("OPENAI_API_KEY is not set");
if (!COMPOSIO_API_KEY) throw new Error("COMPOSIO_API_KEY is not set");
if (!COMPOSIO_USER_ID) throw new Error("COMPOSIO_USER_ID is not set");

What's happening:

This ensures missing credentials cause early, clear errors before the agent attempts to initialise.

7

Create a Tool Router session and build the agent function

async function buildAgent() {

  console.log(`Initializing Composio client...${COMPOSIO_USER_ID!}...`);
  console.log(`COMPOSIO_USER_ID: ${COMPOSIO_USER_ID!}...`);

  const composio = new Composio({
    apiKey: COMPOSIO_API_KEY,
    provider: new LlamaindexProvider(),
  });

  const session = await composio.create(
    COMPOSIO_USER_ID!,
    {
      toolkits: ["habitica"],
    },
  );

  const mcpUrl = session.mcp.url;
  console.log(`Composio Tool Router MCP URL: ${mcpUrl}`);

  const server = mcp({
    url: mcpUrl,
    clientName: "composio_tool_router_with_llamaindex",
    requestInit: {
      headers: {
        "x-api-key": COMPOSIO_API_KEY!,
      },
    },
    // verbose: true,
  });

  const tools = await server.tools();

  const llm = openai({ apiKey: OPENAI_API_KEY, model: "gpt-5" });

  const agent = createAgent({
    name: "composio_tool_router_with_llamaindex",
        description : "An agent that uses Composio Tool Router MCP tools to perform actions.",
    systemPrompt:
      "You are a helpful assistant connected to Composio Tool Router."+
"Use the available tools to answer user queries and perform Habitica actions." ,
    llm,
    tools,
  });

  return agent;
}

What's happening here:

  • We create a Composio client using your API key and configure it with the LlamaIndex provider
  • We then create a tool router MCP session for your user, specifying the toolkits we want to use (in this case, habitica)
  • The session returns an MCP HTTP endpoint URL that acts as a gateway to all your configured tools
  • LlamaIndex will connect to this endpoint to dynamically discover and use the available Habitica tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.
8

Create an interactive chat loop

async function chatLoop(agent: ReturnType<typeof createAgent>) {
  const rl = readline.createInterface({ input, output });

  console.log("Type 'quit' or 'exit' to stop.");

  while (true) {
    let userInput: string;

    try {
      userInput = (await rl.question("\nYou: ")).trim();
    } catch {
      console.log("\nAgent: Bye!");
      break;
    }

    if (!userInput) {
      continue;
    }

    const lower = userInput.toLowerCase();
    if (lower === "quit" || lower === "exit") {
      console.log("Agent: Bye!");
      break;
    }

    try {
      process.stdout.write("Agent: ");

      const stream = agent.runStream(userInput);
      let finalResult: any = null;

      for await (const event of stream) {
        // The event.data contains the streamed content
        const data: any = event.data;

        // Check for streaming delta content
        if (data?.delta) {
          process.stdout.write(data.delta);
        }

        // Store final result for fallback
        if (data?.result || data?.message) {
          finalResult = data;
        }
      }

      // If no streaming happened, show the final result
      if (finalResult) {
        const answer =
          finalResult.result ??
          finalResult.message?.content ??
          finalResult.message ??
          "";
        if (answer && typeof answer === "string" && !answer.includes("[object")) {
          process.stdout.write(answer);
        }
      }

      console.log(); // New line after streaming completes
    } catch (err: any) {
      console.error("\nAgent error:", err?.message ?? err);
    }
  }

  rl.close();
}

What's happening:

  • We're creating a direct terminal interface to chat with Habitica
  • The LLM's responses are streamed to the CLI for faster interaction.
  • The agent uses context to maintain conversation history
  • The agent processes the request, selects appropriate Habitica tools, and returns a result
  • We extract the answer from the result data structure and display it to the user
  • You can type 'quit' or 'exit' to stop the chat loop gracefully
  • Agent responses and any errors are streamed in a clear, readable format
9

Define the main entry point

async function main() {
  try {
    const agent = await buildAgent();
    await chatLoop(agent);
  } catch (err) {
    console.error("Failed to start agent:", err);
    process.exit(1);
  }
}

main();

What's happening here:

  • We're orchestrating the entire application flow
  • The agent gets built with proper error handling
  • Then we kick off the interactive chat loop so you can start talking to Habitica
10

Run the agent

npx ts-node llamaindex-agent.ts

When prompted, authenticate and authorise your agent with Habitica, then start asking questions.

Complete Code

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

import "dotenv/config";
import readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";

import { Composio } from "@composio/core";
import { LlamaindexProvider } from "@composio/llamaindex";

import { mcp } from "@llamaindex/tools";
import { agent as createAgent } from "@llamaindex/workflow";
import { openai } from "@llamaindex/openai";

dotenv.config();

const OPENAI_API_KEY = process.env.OPENAI_API_KEY;
const COMPOSIO_API_KEY = process.env.COMPOSIO_API_KEY;
const COMPOSIO_USER_ID = process.env.COMPOSIO_USER_ID;

if (!OPENAI_API_KEY) {
    throw new Error("OPENAI_API_KEY is not set in the environment");
  }
if (!COMPOSIO_API_KEY) {
    throw new Error("COMPOSIO_API_KEY is not set in the environment");
  }
if (!COMPOSIO_USER_ID) {
    throw new Error("COMPOSIO_USER_ID is not set in the environment");
  }

async function buildAgent() {

  console.log(`Initializing Composio client...${COMPOSIO_USER_ID!}...`);
  console.log(`COMPOSIO_USER_ID: ${COMPOSIO_USER_ID!}...`);

  const composio = new Composio({
    apiKey: COMPOSIO_API_KEY,
    provider: new LlamaindexProvider(),
  });

  const session = await composio.create(
    COMPOSIO_USER_ID!,
    {
      toolkits: ["habitica"],
    },
  );

  const mcpUrl = session.mcp.url;
  console.log(`Composio Tool Router MCP URL: ${mcpUrl}`);

  const server = mcp({
    url: mcpUrl,
    clientName: "composio_tool_router_with_llamaindex",
    requestInit: {
      headers: {
        "x-api-key": COMPOSIO_API_KEY!,
      },
    },
    // verbose: true,
  });

  const tools = await server.tools();

  const llm = openai({ apiKey: OPENAI_API_KEY, model: "gpt-5" });

  const agent = createAgent({
    name: "composio_tool_router_with_llamaindex",
    description:
      "An agent that uses Composio Tool Router MCP tools to perform actions.",
    systemPrompt:
      "You are a helpful assistant connected to Composio Tool Router."+
"Use the available tools to answer user queries and perform Habitica actions." ,
    llm,
    tools,
  });

  return agent;
}

async function chatLoop(agent: ReturnType<typeof createAgent>) {
  const rl = readline.createInterface({ input, output });

  console.log("Type 'quit' or 'exit' to stop.");

  while (true) {
    let userInput: string;

    try {
      userInput = (await rl.question("\nYou: ")).trim();
    } catch {
      console.log("\nAgent: Bye!");
      break;
    }

    if (!userInput) {
      continue;
    }

    const lower = userInput.toLowerCase();
    if (lower === "quit" || lower === "exit") {
      console.log("Agent: Bye!");
      break;
    }

    try {
      process.stdout.write("Agent: ");

      const stream = agent.runStream(userInput);
      let finalResult: any = null;

      for await (const event of stream) {
        // The event.data contains the streamed content
        const data: any = event.data;

        // Check for streaming delta content
        if (data?.delta) {
          process.stdout.write(data.delta);
        }

        // Store final result for fallback
        if (data?.result || data?.message) {
          finalResult = data;
        }
      }

      // If no streaming happened, show the final result
      if (finalResult) {
        const answer =
          finalResult.result ??
          finalResult.message?.content ??
          finalResult.message ??
          "";
        if (answer && typeof answer === "string" && !answer.includes("[object")) {
          process.stdout.write(answer);
        }
      }

      console.log(); // New line after streaming completes
    } catch (err: any) {
      console.error("\nAgent error:", err?.message ?? err);
    }
  }

  rl.close();
}

async function main() {
  try {
    const agent = await buildAgent();
    await chatLoop(agent);
  } catch (err: any) {
    console.error("Failed to start agent:", err?.message ?? err);
    process.exit(1);
  }
}

main();

Conclusion

You've successfully connected Habitica to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Habitica tools through an MCP endpoint
  • LlamaIndex's ReActAgent handles reasoning and orchestration; Composio handles integrations
  • The agent becomes more capable without increasing prompt size
  • Async Python provides clean, efficient execution of agent workflows
You can easily extend this to other toolkits like Gmail, Notion, Stripe, GitHub, and more by adding them to the toolkits parameter.
TOOLS

Supported Tools

Every Habitica action and event your agent gets out of the box.

Add Task to Challenge

Tool to add a new task to a specified challenge.

Add Push Device

Tool to register a push notification device for the authenticated user.

Add Tag to Task

Tool to add a tag to a task.

Clone Challenge

Tool to clone an existing challenge.

Create Challenge

Tool to create a new challenge.

Create Habitica Party

Create a new Habitica party for collaborative gameplay.

Create Tag

Tool to create a new tag.

Create Task

Create a new task in Habitica.

Create Webhook

Tool to create a new webhook for taskActivity events.

Delete Habitica Challenge

Permanently delete a Habitica challenge.

Leave or Delete Habitica Group

Leave or delete a Habitica group (party or guild).

Delete Group Chat Message

Tool to delete a chat message from a Habitica group (party, guild, or Tavern).

Delete Habitica Tag

Tool to delete a tag for the authenticated user.

Delete Task

Permanently deletes a user's task (habit, daily, todo, or reward) by its ID.

Delete Task Checklist Item

Tool to delete a checklist item from a task.

Delete User Message

Tool to delete a message from the authenticated user's inbox by its ID.

Delete User Push Device

Tool to remove a push device registration from the authenticated user's account.

Equip Item

Tool to equip or unequip gear, pets, mounts, or costume items in Habitica.

Export Challenge to CSV

Tool to export a Habitica challenge to CSV format.

Get Challenge

Tool to retrieve details of a specific challenge.

Get Group Challenges

Tool to retrieve challenges available in a specific group (guild, party, or tavern).

Get Task by ID

Retrieve a task by its unique ID.

Get Challenge Tasks

Tool to get all tasks for a specified challenge.

Get Content

Retrieves all Habitica game content definitions in a single request.

Get Content By Type

Retrieves Habitica game content data filtered by a specific category type.

Get Export History CSV

Tool to export user tasks history in CSV format.

Get Export Inbox HTML

Tool to export inbox data in HTML format from Habitica.

Export User Data JSON

Exports the authenticated user's complete data in JSON format.

Get Group

Retrieves detailed information about a Habitica group (guild or party).

Get Group Members

Retrieve members of a Habitica group (guild or party).

Get Habitica Groups

Retrieves Habitica groups based on type.

Get Habitica Tavern Group

Tool to retrieve the Habitica Tavern (habitrpg) group details.

Get Party Chat Messages

Tool to retrieve party chat messages from Habitica.

Get Model Paths

Retrieves all available field paths and their data types for a specified Habitica model.

Get News

Tool to retrieve the latest Bailey announcement from Habitica.

Get Party

Retrieves the authenticated user's party details from Habitica.

Get Shops Market Gear

Tool to retrieve the available gear for purchase in the market shop.

Get Time Travelers Shop

Tool to retrieve available items in the Time Travelers shop.

Get Habitica API Status

Tool to check Habitica API server status.

Get Tags

Retrieve all tags for the authenticated Habitica user.

Get Tasks

Tool to retrieve all tasks for the authenticated user.

Get User Challenges

Tool to retrieve challenges the authenticated user participates in.

Get User Profile

Retrieves the authenticated user's complete Habitica profile.

Get Webhooks

Retrieves all webhooks configured for the authenticated Habitica user.

Get World State

Retrieves the current state of the Habitica game world including active events, world boss status, and seasonal NPC visual themes.

Invite To Group

Tool to invite users to a specific group.

Invite To Quest

Tool to invite party members to a quest.

Join Challenge

Tool to join a challenge.

Leave Challenge

Tool to leave a Habitica challenge.

Local Login

Tool to authenticate a user via local credentials.

Local User Registration

Tool to register a new Habitica user via email and password.

Mark Group Chat Seen

Tool to mark all chat messages as read/seen for a specific group.

Mark Notification Seen

Tool to mark a single notification as seen in Habitica.

Mark Notifications Seen

Marks specific notifications as read/seen in Habitica.

Move Pinned Item

Tool to move a pinned item in the rewards column to a new position.

Move Task To Position

Move a Habitica task to a new position in the task list.

Dismiss Bailey Announcement

Tool to dismiss the latest Bailey announcement in Habitica, allowing it to be read later.

Reset User Account

Resets the authenticated user's account to starting state.

Read Card

Tool to mark a card as read in Habitica.

Remove Party Member

Removes a member from the authenticated user's party.

Score Task

Score a Habitica task to mark it as completed or incomplete.

Social Auth

Tool to authenticate a user via a social provider.

Subscribe Webhook

Tool to enable (subscribe) an existing webhook by ID for the authenticated user.

Unlink All Challenge Tasks

Tool to unlink all tasks from a Habitica challenge.

Update Group

Tool to update a Habitica group (party or guild) by modifying its properties.

Update Tag

Tool to update an existing tag's name.

Update Task

Update an existing task in Habitica.

Update Task Checklist Item

Tool to update a checklist item in a task.

Update User

Update the authenticated user's profile, preferences, flags, and other settings in Habitica.

Validate Coupon Code

Validate a Habitica coupon code to check if it is valid and active.

FRAMEWORKS

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

CrewAI logo

CrewAI

Use Habitica MCP with CrewAI

FAQ

Frequently asked questions

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.

Yes, you can. LlamaIndex 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.

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.

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.

Start with Habitica.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Habitica tool your agent needs.Free to start.

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

Karan skipped his own birthday party to fix our critical issue. It was 10pm and he diverted his Waymo to help us instead. This really sets the bar — it shows the commitment you need when users rely on your software.

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

We chose Composio over Pipedream because it delivered depth where it mattered — niche tools and tricky edge cases other platforms simply ignored. That gave us confidence to scale without compromising.

Nirman Dave
Nirman Dave
CEO, Zams

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down managing agent auth would have been a death sentence.

Ryan Yu
Ryan Yu
Founder, Extra Thursday

Before Composio, adding tool integrations was slow and resource-intensive. Each one could take weeks of engineering time, and maintaining them meant constantly keeping up with API changes.

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies