How to integrate Iterable MCP with LlamaIndex

This guide walks you through connecting Iterable to LlamaIndex using the Composio tool router. By the end, you'll have a working Iterable agent that can summarize iterable campaign performance today, add customer to welcome journey, update user email subscription status through natural language commands. This guide will help you understand how to give your LlamaIndex agent real control over a Iterable account through Composio's Iterable MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Iterable logoIterable
Api Key

Iterable is a cross-channel marketing platform for building campaigns across email, SMS, push, and in-app channels. It helps teams personalize customer journeys and optimize engagement from one place.

116 Tools

Introduction

This guide walks you through connecting Iterable to LlamaIndex using the Composio tool router. By the end, you'll have a working Iterable agent that can summarize iterable campaign performance today, add customer to welcome journey, update user email subscription status through natural language commands.

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

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

Also integrate Iterable with

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 Iterable
  • Connect LlamaIndex to the Iterable MCP server
  • Build a Iterable-powered agent using LlamaIndex
  • Interact with Iterable 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 Iterable MCP server, and what's possible with it?

The Iterable MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Iterable account. It provides structured and secure access to your campaigns, users, catalogs, templates, messages, and analytics, so your agent can create campaigns, manage audiences, update catalogs, control messages, and review performance on your behalf.

  • Campaign creation and control: Have your agent create campaigns from existing templates, activate or deactivate triggered campaigns, cancel scheduled campaigns, archive campaigns, or stop campaigns already running.
  • User and audience management: Let the agent create static lists, update users in bulk, export user events, delete users, or remove a person’s data and prevent future collection.
  • Catalog and content management: Direct your agent to create catalogs, add or update catalog items, inspect catalog content and field mappings, and remove items or entire catalogs.
  • Message and template operations: Instruct your agent to review email, in-app, and embedded message templates, create reusable snippets, list message types, and cancel scheduled email, push, web push, in-app, or WhatsApp messages.
  • Campaign reporting and exports: Have your agent retrieve campaign and experiment metrics, then export campaign analytics in CSV or JSON format for further analysis.

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 Iterable account and project
  • Basic familiarity with async Python/Typescript
2

Getting API Keys for OpenAI, Composio, and Iterable

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 Iterable 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 iterable_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: ["iterable"],
    },
  );

  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 Iterable 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, iterable)
  • 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 Iterable 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 Iterable
  • 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 Iterable 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 Iterable
10

Run the agent

npx ts-node llamaindex-agent.ts

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

Complete Code

Here's the complete code to get you started with Iterable 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: ["iterable"],
    },
  );

  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 Iterable 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 Iterable to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Iterable 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 Iterable action and event your agent gets out of the box.

Abort Campaign

Abort a running campaign to stop all in-progress message deliveries.

Activate a triggered campaign

Activates a triggered campaign by its unique ID, allowing it to process events and send messages.

Archive Campaigns

Archives one or more campaigns.

Bulk Update Users

Bulk update user data in Iterable.

Cancel Campaign

Cancel a scheduled or recurring campaign in Iterable.

Cancel Email

Cancel a scheduled email to a specific user in Iterable.

Cancel Export

Cancel a queued or running export created with the 'Start export' endpoint.

Cancel In-App Message

Cancel a scheduled in-app message to a specific user in Iterable.

Cancel Push

Cancel a scheduled push notification to a specific user in Iterable.

Cancel Web Push

Cancel a scheduled web push notification to a specific user in Iterable.

Cancel WhatsApp

Cancel a scheduled WhatsApp message to a specific user in Iterable.

Create a new campaign

Creates a new blast or triggered campaign from an existing template.

Create a catalog

Create a catalog with the specified name in Iterable.

Create Catalog Items

Asynchronously creates or updates up to 1000 catalog items with a single request.

Create a new list

Create a new static list in Iterable.

Create snippet

Creates a new code snippet in Iterable.

Deactivate Triggered Campaign

Deactivate a triggered campaign in Iterable.

Bulk delete templates

Bulk delete one or more base templates from Iterable.

Delete a catalog

Delete a catalog by its name.

Delete a Catalog Item

Deletes the specified item from a catalog.

Delete Catalog Items

Asynchronously deletes catalog items from a specified catalog in Iterable.

Delete a list

Delete a list by its listId.

Delete Metadata Table

Asynchronously deletes a metadata table by its table name.

Delete snippet

Deletes a snippet by its ID (numeric) or name (string).

Delete User By ID

Asynchronously deletes a user by userId from Iterable.

Export data to CSV

Export campaign analytics data in CSV format from Iterable.

Export Campaign Data to JSON

Export campaign analytics data in JSON format with one entry per line.

Export User Events

Export all events for a user identified by email or userId.

Forget User

Deletes the specified user's data from the Iterable project and prevents future data collection about them.

Get campaign by ID

Retrieves a campaign by its unique ID.

Get Campaign Metrics

Retrieve performance metrics for one or more campaigns.

Get Catalog Field Mappings

Tool to retrieve field mappings (field to data type) and undefined fields for a catalog in Iterable.

Get catalog item by ID

Retrieves a specific catalog item by its ID from the specified catalog.

Get email template by ID

Get an email template by templateId.

Get Embedded Messages

Retrieves embedded messages for which the specified user is eligible, grouped by placementId.

Get Embedded Template

Retrieves an embedded message template by its unique ID.

Get Experiment Metrics

Retrieve metrics for email experiments.

Get In-App Messages

Get a user's in-app messages from Iterable.

Get in-app template by ID

Retrieves an in-app template by its unique ID.

Get List Size

Get the number of users within a list.

Get push template by ID

Retrieves a push template by its unique ID.

Get SMS template

Retrieves an SMS template by its unique ID.

Get snippet by ID or name

Retrieves a snippet by its ID (numeric) or name (string).

Get template by client template ID

Retrieves an email template by its client-defined template ID.

Get User By ID

Get a user by userId from Iterable.

Get User By ID (Path)

Get a user by userId (path parameter) from Iterable.

Get User Events

Get events for a specific user by userId.

Get User Sent Messages

Get messages sent to a user by email address or userId.

Get Web In-App Messages

Get a user's web in-app messages from Iterable.

List all campaigns

Retrieves metadata about all campaigns in a project with optional pagination.

List Catalog Items

Get the catalog items for a catalog.

List Catalogs

Tool to retrieve all catalog names from Iterable.

List Channels

Get all message channels within the Iterable project.

List export files

Get the job status and files for an export started with the 'Start export' endpoint.

List Export Jobs

Retrieve a list of recent export jobs for the current project.

List Forgotten User IDs

Get hashed user IDs of forgotten users for GDPR compliance.

List Journeys

Get a list of journeys (workflows) within your Iterable project.

List Lists

Retrieve all lists within a project.

List List Users

Get all users within a list.

List Message Types

Lists all message types within a project.

List Metadata Keys

List all keys in a metadata table.

List Metadata Tables

List available metadata tables in Iterable.

List recurring campaign child campaigns

Retrieve the child campaigns generated by a recurring campaign.

List Snippets

Get all snippets for the current project.

List all templates

Retrieves metadata about all templates in a project with optional pagination.

List User Fields

Get all user fields within a project.

List Webhooks

Get all webhooks configured within the Iterable project.

Merge Users

Merge two user profiles in Iterable.

Preview email template

Generate a fully rendered HTML preview of an email template using custom data.

Preview in-app template

Generate a fully rendered HTML preview of an in-app template using custom data.

Preview List Users

Get a random sample of up to 5000 users within a list.

Replace Catalog Item

Asynchronously creates or replaces the specified catalog item in the given catalog.

Replace Metadata Item

Asynchronously creates or replaces the metadata item associated with the specified key.

Schedule Campaign

Schedule an existing campaign to be sent at a specified time.

Send Campaign

Send an existing campaign immediately in Iterable.

Send email template proof

Send a proof of an email template to a specific user.

Send in-app notification to target

Send an in-app notification to a specific user using Iterable.

Send in-app template proof

Send a proof of an in-app template to a specific user using Iterable.

Send push to target

Send a push notification to a specific user using Iterable.

Send push template proof

Send a proof of a push template to a specific user.

Send SMS template proof

Send a proof of an SMS template to a specific user.

Send WhatsApp to target

Send a WhatsApp message to a specific user using Iterable.

Start Export

Start a data export job.

Subscribe to List

Subscribe one or more users to a specific list in Iterable.

Subscribe User By ID

Subscribes a user to the specified subscription group by their userId.

Track Embedded Click

Tracks a click event on an embedded message.

Track Embedded Received

Track that an embedded message was received on a device.

Track Embedded Session

Tracks an embedded message session and related impressions in Iterable.

Track Event

Track an event in Iterable.

Track Events in Bulk

Track multiple events in bulk in Iterable.

Track Purchase

Track a purchase event in Iterable.

Trigger Campaign

Trigger a campaign to send to one or more lists of recipients.

Trigger Journey

Trigger a journey (workflow) in Iterable for a specific user or list.

Unforget User

Unforgets a previously forgotten user in Iterable, resuming data collection.

Unsubscribe from list

Remove users from a list.

Unsubscribe User By ID

Unsubscribes a user from the specified subscription group by their userId.

Update Shopping Cart

Update a user's shopping cart items in Iterable.

Update Catalog Field Mappings

Set a catalog's field mappings (data types) in Iterable.

Update Catalog Item

Asynchronously creates or updates the specified catalog item in the given catalog.

Update email template

Update an existing email template in Iterable.

Update Embedded Template

Updates an embedded message template with the specified fields.

Update in-app template

Update an existing in-app template in Iterable.

Update push template

Updates an existing push template in Iterable.

Update SMS template

Update an existing SMS template in Iterable.

Update snippet by ID or name

Updates an existing snippet by ID (numeric) or creates/updates a snippet by name (string).

Update User

Update user data or add a user if none exists in Iterable.

Update User Email

Updates a user's email address in Iterable.

Update User Subscriptions

Updates user subscription preferences in Iterable.

Bulk Update User Subscriptions

Bulk update subscription preferences for multiple users in Iterable.

Update Webhook

Update an existing webhook configuration in Iterable.

Upsert email template

Create or update an email template in Iterable.

Upsert Embedded Template

Creates an embedded message template if it doesn't exist, or updates all embedded message templates that match the provided clientTemplateId.

Upsert in-app template

Create or update an in-app template in Iterable.

Upsert push template

Create or update a push template in Iterable.

Upsert SMS template

Create or update an SMS template in Iterable.

Verify SMS Code

Verifies an SMS verification code sent to a phone number in Iterable.

FAQ

Frequently asked questions

With a standalone Iterable MCP server, the agents and LLMs can only access a fixed set of Iterable tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Iterable 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 Iterable tools.

Yes, absolutely. You can configure which Iterable 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 Iterable data and credentials are handled as safely as possible.

Start with Iterable.It takes 30 seconds.

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

Start building