How to integrate Shippo MCP with LlamaIndex

This guide walks you through connecting Shippo to LlamaIndex using the Composio tool router. By the end, you'll have a working Shippo agent that can create shipping label for new order, track shipment status by tracking number, get shipping rates for a package through natural language commands. This guide will help you understand how to give your LlamaIndex agent real control over a Shippo account through Composio's Shippo MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Shippo logoShippo
Api KeyOauth2

Shippo is a shipping API for e-commerce merchants to create labels, track packages, and manage shipments. It streamlines shipping operations with multi-carrier support and easy integration.

95 Tools

Introduction

This guide walks you through connecting Shippo to LlamaIndex using the Composio tool router. By the end, you'll have a working Shippo agent that can create shipping label for new order, track shipment status by tracking number, get shipping rates for a package through natural language commands.

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

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

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

The Shippo MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Shippo account. It provides structured and secure access so your agent can perform Shippo operations on your behalf.

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

Getting API Keys for OpenAI, Composio, and Shippo

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 Shippo 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 shippo_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: ["shippo"],
    },
  );

  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 Shippo 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, shippo)
  • 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 Shippo 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 Shippo
  • 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 Shippo 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 Shippo
10

Run the agent

npx ts-node llamaindex-agent.ts

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

Complete Code

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

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

Create Shippo Address

Tool to create a new address in Shippo.

Create Batch

Tool to create a batch of shipments for bulk label purchasing.

Create Carrier Account

Tool to create a new carrier account in Shippo.

Create Customs Item

Create a new customs item for international shipments.

Create Live Rate

Tool to generate live shipping rates from multiple carriers for a given shipment.

Create Manifest

Tool to create a new shipping manifest with Shippo.

Create Merchant Address

Tool to create a new address for a merchant using Shippo's Platform API.

Create Merchant Batch

Tool to create a batch for a merchant using the Shippo Platform API.

Create Merchant Carrier Account

Tool to create a carrier account for a merchant using the Shippo Platform API.

Create Merchant Customs Declaration

Tool to create a new customs declaration for a merchant using Shippo's Platform API.

Create Merchant Customs Item

Tool to create a new customs item for a merchant using Shippo's Platform API.

Create Merchant Order

Tool to create an order for a merchant using the Shippo Platform API.

Create Merchant Parcel

Tool to create a new parcel for a merchant using Shippo's Platform API.

Create Merchant Refund

Tool to create a refund for a merchant using the Shippo Platform API.

Create Merchant Shipment

Tool to create a new shipment for a merchant using Shippo's Platform API.

Create Merchant Transaction

Tool to create a shipping label transaction for a merchant using the Shippo Platform API.

Create Order

Tool to create a new order in Shippo.

Create Parcel

Tool to create a new parcel in Shippo with dimensions and weight specifications.

Create Refund

Tool to create a refund for a Shippo transaction.

Create Service Group

Tool to create a new Shippo service group with specified pricing model and carrier service levels.

Create Shipment

Tool to create a new shipment with Shippo.

Register Tracking Webhook

Tool to register a tracking webhook for a shipment.

Create Transaction

Tool to create a shipping label transaction with Shippo.

Create User Parcel Template

Tool to create a new user parcel template in Shippo with preset dimensions and weight specifications.

Create Shippo Webhook

Tool to create a new webhook subscription in Shippo.

Delete Default Parcel Template

Tool to clear the current default parcel template.

Delete User Parcel Template

Tool to delete a user-created parcel template.

Delete Webhook

Tool to delete a specific webhook from Shippo.

Get Address

Tool to retrieve a previously created address from Shippo.

Get Carrier Account

Tool to retrieve a carrier account by its ID.

Get Carrier Parcel Template

Tool to retrieve a specific carrier parcel template by its token.

Get Carrier Registration Status

Tool to retrieve carrier registration status from Shippo.

Get Customs Declaration

Tool to retrieve a customs declaration by its ID.

Get customs item

Tool to retrieve a customs item from Shippo.

Get Default Parcel Template

Tool to retrieve the current default parcel template for live rates at checkout.

Get Merchant

Tool to retrieve a merchant from the Shippo Platform API.

Get Merchant Address

Tool to retrieve a merchant address from Shippo Platform API.

Get Merchant Batch

Tool to retrieve a batch for a merchant from the Shippo Platform API.

Get Merchant Carrier Account

Tool to retrieve a carrier account for a merchant using the Shippo Platform API.

Get Merchant Carrier Registration Status

Tool to retrieve carrier registration status for a specific merchant using Shippo's Platform API.

Get Merchant Customs Declaration

Tool to retrieve a specific customs declaration for a merchant using Shippo's Platform API.

Get Merchant Customs Item

Tool to retrieve a customs item for a merchant using the Shippo Platform API.

Get Merchant Manifest

Tool to retrieve a manifest for a merchant from the Shippo Platform API.

Get Merchant Order

Tool to retrieve an order for a merchant from the Shippo Platform API.

Get Merchant Parcel

Tool to retrieve a parcel for a merchant from the Shippo Platform API.

Get Merchant Rate

Tool to retrieve a specific shipping rate for a merchant using the Shippo Platform API.

Get Merchant Refund

Tool to retrieve a merchant refund from Shippo Platform API.

Get Merchant Shipment

Tool to retrieve a shipment for a merchant from the Shippo Platform API.

Get Merchant Tracking Status

Tool to retrieve tracking status for a merchant from Shippo Platform API.

Get Merchant Transaction

Tool to retrieve a shipping label transaction for a merchant from the Shippo Platform API.

Get Order

Tool to retrieve an order from Shippo.

Get Parcel

Tool to retrieve a parcel by its ID.

Get Rate

Tool to retrieve a specific shipping rate by its ID.

Get Refund

Tool to retrieve a refund by its ID from Shippo.

Get Shipment

Tool to retrieve a shipment by its ID.

Get Shippo Account

Tool to retrieve a Shippo Account from the Shippo Platform API.

Get Tracking Status

Tool to retrieve tracking status for a shipment from Shippo.

Get Transaction

Tool to retrieve a shipping label transaction by its ID.

Get User Parcel Template

Tool to retrieve a specific user-created parcel template by its object ID.

Get Webhook

Tool to retrieve a specific webhook subscription from Shippo.

List Addresses

Tool to list all addresses in the Shippo account with pagination support.

List Carrier Accounts

Tool to list all carrier accounts configured in the Shippo account with pagination support.

List Carrier Parcel Templates

Tool to list all carrier parcel templates available for creating shipments.

List Customs Declarations

Tool to list all customs declarations in the Shippo account with pagination support.

List Customs Items

Tool to list all customs items with pagination support.

List Manifests

Tool to list all shipping manifests from Shippo.

List Merchant Addresses

Tool to list all addresses for a specific merchant using the Shippo Platform API.

List Merchant Carrier Accounts

Tool to list all carrier accounts for a specific merchant using the Shippo Platform API.

List Merchant Customs Declarations

Tool to list all customs declarations for a specific merchant using the Shippo Platform API.

List Merchant Customs Items

Tool to list all customs items for a specific merchant using the Shippo Platform API.

List Merchant Manifests

Tool to list all manifests for a specific merchant using Shippo's Platform API.

List Merchant Parcels

Tool to list all parcels for a specific merchant using the Shippo Platform API.

List Merchants

Tool to list all merchants using the Shippo Platform API with pagination support.

List Merchant Shipment Rates by Currency

Tool to retrieve available shipping rates for a merchant's shipment filtered by currency code using the Shippo Platform API.

List Merchant Shipments

Tool to list all shipments for a specific merchant using Shippo's Platform API.

List Merchant Transactions

Tool to list all shipping label transactions for a merchant using the Shippo Platform API.

List Orders

Tool to list all orders in the Shippo account with pagination support.

List Refunds

Tool to retrieve a list of all refunds from Shippo.

List Service Groups

Tool to retrieve all service groups configured in Shippo.

List Shipment Rates

Tool to retrieve available shipping rates for a specific shipment.

List Shipment Rates by Currency

Tool to retrieve available shipping rates for a specific shipment filtered by currency code.

List Shipments

Tool to list all shipments in the Shippo account with pagination support.

List Shippo Accounts

Tool to list all Managed Shippo Accounts.

List User Parcel Templates

Tool to list all user-created parcel templates.

Purchase Merchant Batch

Tool to purchase a batch for a merchant via the Shippo Platform API.

Remove Shipments From Batch

Tool to remove shipments from a batch for a merchant using the Shippo Platform API.

Update Carrier Account

Tool to update an existing carrier account in Shippo.

Update Default Parcel Template

Tool to update the default parcel template for live rates at checkout in Shippo.

Update Merchant

Tool to update an existing merchant in Shippo Platform API.

Update Merchant Carrier Account

Tool to update a carrier account for a merchant in Shippo Platform API.

Update Service Group

Tool to update an existing Shippo service group.

Update User Parcel Template

Tool to update an existing user parcel template with new weight and carrier template settings.

Update Webhook

Tool to update an existing webhook in Shippo.

Validate Address

Tool to validate an address using the Shippo API.

Validate Merchant Address

Tool to validate a merchant address using the Shippo Platform API.

FAQ

Frequently asked questions

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

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

Start with Shippo.It takes 30 seconds.

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

Start building