How to integrate Instantly MCP with LlamaIndex

This guide walks you through connecting Instantly to LlamaIndex using the Composio tool router. By the end, you'll have a working Instantly agent that can create a new cold email campaign, add a new lead to your campaign, check unread emails in your inbox through natural language commands. This guide will help you understand how to give your LlamaIndex agent real control over a Instantly account through Composio's Instantly MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Instantly logoInstantly
Api Key

Instantly is a platform for automating cold email outreach, managing leads, and optimizing deliverability. Get better results from email campaigns with minimal manual effort.

115 Tools

Introduction

This guide walks you through connecting Instantly to LlamaIndex using the Composio tool router. By the end, you'll have a working Instantly agent that can create a new cold email campaign, add a new lead to your campaign, check unread emails in your inbox through natural language commands.

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

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

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

The Instantly MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Instantly account. It provides structured and secure access to your campaigns, leads, and outreach tools, so your agent can perform actions like launching new campaigns, managing leads, tracking inbox statistics, and handling API credentials on your behalf.

  • Automated campaign creation and management: Ask your agent to launch new cold email campaigns or update existing ones, streamlining your outreach workflow without manual setup.
  • Lead and lead list management: Let your agent add new leads, organize them into lists, or enrich them with AI-driven insights to maximize your campaign effectiveness.
  • Email verification and deliverability tracking: Direct your agent to check the verification status of email addresses or run inbox placement tests to monitor and improve deliverability across providers.
  • Inbox activity monitoring: Fetch unread email counts or campaign engagement metrics, helping you stay on top of your outreach performance in real time.
  • API key and webhook automation: Have your agent create or delete API keys for secure integrations, or set up webhooks to receive instant notifications about important Instantly events.

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

Getting API Keys for OpenAI, Composio, and Instantly

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 Instantly 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 instantly_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: ["instantly"],
    },
  );

  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 Instantly 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, instantly)
  • 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 Instantly 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 Instantly
  • 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 Instantly 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 Instantly
10

Run the agent

npx ts-node llamaindex-agent.ts

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

Complete Code

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

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

Check Custom Tracking Domain Status

Tool to check Custom Tracking Domain (CTD) status for email accounts.

Activate Campaign

Tool to activate or resume a paused campaign.

Add Leads in Bulk

Tool to add multiple leads in bulk to a campaign or list.

Get API Keys

Tool to retrieve paginated list of API keys for organization.

Bulk Assign Leads

Tool to bulk assign leads to organization users.

Get Campaigns Analytics Overview

Tool to get analytics overview for one or multiple campaigns.

Import Campaign from Export

Tool to import a campaign from exported data.

Check DFY Email Account Order Domains

Tool to check domain availability for DFY email account orders.

Check Email Verification Status

Tool to check status of an email verification job.

Count Launched Campaigns

Tool to retrieve the count of launched campaigns.

Count Leads from SuperSearch

Tool to count leads matching supersearch filter criteria.

Count Unread Emails

Tool to retrieve the count of unread emails.

Create AI Enrichment

Tool to create an AI enrichment job for a campaign or lead list.

Create API Key

Creates a new API key with specified permissions for the Instantly API.

Create Block List Entry

Tool to create a new block list entry for a specific email or domain.

Create Campaign

Tool to create a new campaign.

Create Custom Tag

Tool to create a new custom tag for organizing accounts and campaigns.

Create Inbox Placement Test

Tool to create an inbox placement test.

Create Lead

Tool to create a new lead.

Create Lead List

Tool to create a new lead list.

Create Subsequence

Creates an automated follow-up subsequence for a campaign.

Create SuperSearch Enrichment

Tool to create a supersearch enrichment job for a list or campaign.

Create Webhook

Tool to create a new webhook endpoint.

Delete API Key

Tool to delete an API key.

Delete Block List Entry

Tool to delete a blocked email or domain entry by its ID.

Delete Campaign

Tool to delete a campaign.

Delete Custom Tag

Tool to delete a custom tag by its ID.

Delete Lead

Tool to delete a lead by its ID.

Delete Lead Label

Tool to delete a lead label by ID.

Delete Lead List

Tool to delete a lead list by ID.

Delete Subsequence

Delete a subsequence from a campaign by its UUID.

Delete Webhook

Tool to delete a webhook.

Delete Whitelabel Domain

Tool to delete the whitelabel domain from current workspace.

List Pre-warmed Up DFY Domains

Tool to retrieve a list of pre-warmed up domains ready for DFY email account orders.

Disable Account Warmup

Tool to disable the warm-up process for email accounts.

Duplicate Campaign

Tool to duplicate an existing campaign.

Duplicate Subsequence

Tool to duplicate an existing subsequence to a specified parent campaign.

Enable Account Warmup

Tool to enable the warm-up process for email accounts.

Export Campaign

Tool to export campaign data to JSON format.

Get Account Campaign Mappings

Tool to retrieve campaigns associated with an email account.

Get Daily Account Analytics

Tool to retrieve daily account analytics showing emails sent per day for each account.

Get Accounts Warmup Analytics

Tool to retrieve warmup analytics for specified email accounts.

Get Audit Logs

Tool to retrieve audit log records for tracking system activities.

Get Block List Entry

Tool to retrieve a specific blocked email or domain entry by its ID.

Get Campaign

Tool to retrieve campaign details.

Get Campaign Analytics

Tool to retrieve analytics for campaigns.

Get Campaign Sending Status

Tool to retrieve campaign sending status diagnostics explaining why a campaign may not be sending emails or is sending slower than expected.

Get Campaign Steps Analytics

Tool to retrieve analytics data broken down by campaign steps and variants.

Get Current Workspace

Tool to retrieve current workspace details based on API key.

Get Custom Tag

Tool to retrieve a specific custom tag by ID.

Get Custom Tag Mappings

Tool to retrieve custom tag mappings that connect tags to resources like campaigns and email accounts.

Get Daily Campaign Analytics

Tool to retrieve daily analytics for a campaign.

Get DFY Email Account Order Accounts

Tool to retrieve DFY (Done-For-You) email account order accounts.

Get Email Service Provider Options

Tool to retrieve email service provider options for inbox placement tests.

Get Inbox Placement Analytics Stats By Date

Tool to retrieve time-series statistics for inbox placement test results by date.

Get Inbox Placement Test

Tool to retrieve inbox placement test results.

Get Lead

Tool to retrieve details of a specific lead by its ID.

Get Lead Label

Tool to retrieve a specific lead label by ID.

Get Lead List

Tool to retrieve details of a specific lead list by its ID.

Get CRM Phone Numbers

Tool to retrieve all phone numbers associated with your organization.

Get Similar DFY Email Account Order Domains

Tool to generate similar available domain suggestions for DFY email account orders.

Get Subsequence

Tool to retrieve a specific subsequence by its ID.

Get SuperSearch Enrichment

Tool to retrieve supersearch enrichment configuration and status for a list or campaign.

Get Lead List Verification Stats

Tool to retrieve verification statistics for a lead list.

Get Webhook

Tool to retrieve details of a specific webhook subscription.

Get Webhook Event

Tool to retrieve details of a specific webhook event.

Get Webhook Events Summary

Tool to retrieve webhook events summary with success and failure statistics.

Get Webhook Events Summary By Date

Tool to retrieve webhook event summaries grouped by date.

Get Webhook Event Types

Tool to retrieve all available webhook event types.

Get Workspace Billing Plan Details

Tool to retrieve workspace billing plan details.

Get Inbox Placement Deliverability Insights

Tool to retrieve deliverability insights for inbox placement tests.

Get Inbox Placement Analytics Stats By Test ID

Tool to retrieve aggregated inbox placement analytics statistics for specified test IDs.

Create Lead Label

Tool to create a custom lead label for categorizing leads.

List Email Accounts

Tool to list all email accounts for the authenticated user.

List Block List Entries

Tool to list blocked emails or domains from blocklist.

List Campaigns

Tool to list all campaigns.

List Custom Tags

Tool to list custom tags.

List DFY Email Account Orders

Tool to list DFY email account orders.

List Emails

Tool to list emails.

List Inbox Placement Blacklist & SpamAssassin Reports

Tool to list inbox placement blacklist & SpamAssassin reports.

List Inbox Placement Tests

Tool to list inbox placement tests.

List Lead Lists

Tool to list all lead lists.

List Leads

Tool to list leads.

List Webhook Events

Tool to list webhook events.

List Webhooks

Tool to list configured webhooks.

Mark Thread As Read

Tool to mark all emails in a specific thread as read.

Merge Leads

Tool to merge multiple leads into a single lead.

Move Leads

Tool to move leads from one campaign to another.

Update Lead Label

Tool to update an existing lead label by ID.

Patch SuperSearch Enrichment Settings

Tool to update auto-update and skip settings for SuperSearch enrichment.

Patch Webhook

Tool to update an existing webhook configuration.

Pause Campaign

Tool to pause an active campaign.

Pause Subsequence

Tool to pause an active campaign subsequence.

Remove Lead From Subsequence

Tool to remove a lead from a campaign subsequence.

Resume Subsequence

Tool to resume a paused campaign subsequence.

Search Campaigns by Lead Email

Tool to search campaigns by a lead's email address.

Set Whitelabel Domain

Tool to set whitelabel agency domain for current workspace.

Share Campaign

Tool to share a campaign.

Run SuperSearch Enrichment

Tool to run all enrichments for resource leads or unenriched leads.

Test Accounts Vitals

Tool to test IMAP/SMTP connectivity and account vitals for email accounts.

Test Webhook

Tool to send a test payload to verify a webhook is working.

Toggle Resource

Tool to assign or unassign custom tags to resources like accounts and campaigns.

Update Block List Entry

Tool to update a blocked email or domain entry.

Update Campaign

Tool to update details of a campaign.

Update Custom Tag

Tool to update an existing custom tag's label or description.

Update Inbox Placement Test

Tool to update an inbox placement test.

Update Lead

Tool to update a lead's details.

Update Lead Interest Status

Tool to update a lead's interest status.

Update Lead List

Tool to update details of a specific lead list by its ID.

Update Subsequence

Tool to update a campaign subsequence entity.

Update Current Workspace

Tool to update the current workspace details.

Verify Email

Tool to initiate email verification.

Get Admin Workspace Group Member

Tool to retrieve admin workspace details for the current sub workspace.

Get Workspace Member by ID

Tool to retrieve details of a specific workspace member by ID.

Add Workspace Member

Tool to add a new member to workspace with email and role.

FAQ

Frequently asked questions

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

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

Start with Instantly.It takes 30 seconds.

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

Start building