How to integrate Shippo MCP with Mastra AI

GET STARTED FOR FREE
Framework Integration Gradient
Shippo Logo
Mastra AI Logo
divider

Introduction

This guide walks you through connecting Shippo to Mastra AI 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 Mastra AI 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.

TL;DR

Here's what you'll learn:
  • Set up your environment so Mastra, OpenAI, and Composio work together
  • Create a Tool Router session in Composio that exposes Shippo tools
  • Connect Mastra's MCP client to the Composio generated MCP URL
  • Fetch Shippo tool definitions and attach them as a toolset
  • Build a Mastra agent that can reason, call tools, and return structured results
  • Run an interactive CLI where you can chat with your Shippo agent

What is Mastra AI?

Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP.

Key features include:

  • MCP Client: Built-in support for Model Context Protocol servers
  • Toolsets: Organize tools into logical groups
  • Step Callbacks: Monitor and debug agent execution
  • OpenAI Integration: Works with OpenAI models via @ai-sdk/openai

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.

Supported Tools & Triggers

Tools
Create Shippo AddressTool to create a new address in Shippo.
Create BatchTool to create a batch of shipments for bulk label purchasing.
Create Carrier AccountTool to create a new carrier account in Shippo.
Create Customs ItemCreate a new customs item for international shipments.
Create Live RateTool to generate live shipping rates from multiple carriers for a given shipment.
Create ManifestTool to create a new shipping manifest with Shippo.
Create Merchant AddressTool to create a new address for a merchant using Shippo's Platform API.
Create Merchant BatchTool to create a batch for a merchant using the Shippo Platform API.
Create Merchant Carrier AccountTool to create a carrier account for a merchant using the Shippo Platform API.
Create Merchant Customs DeclarationTool to create a new customs declaration for a merchant using Shippo's Platform API.
Create Merchant Customs ItemTool to create a new customs item for a merchant using Shippo's Platform API.
Create Merchant OrderTool to create an order for a merchant using the Shippo Platform API.
Create Merchant ParcelTool to create a new parcel for a merchant using Shippo's Platform API.
Create Merchant RefundTool to create a refund for a merchant using the Shippo Platform API.
Create Merchant ShipmentTool to create a new shipment for a merchant using Shippo's Platform API.
Create Merchant TransactionTool to create a shipping label transaction for a merchant using the Shippo Platform API.
Create OrderTool to create a new order in Shippo.
Create ParcelTool to create a new parcel in Shippo with dimensions and weight specifications.
Create RefundTool to create a refund for a Shippo transaction.
Create Service GroupTool to create a new Shippo service group with specified pricing model and carrier service levels.
Create ShipmentTool to create a new shipment with Shippo.
Register Tracking WebhookTool to register a tracking webhook for a shipment.
Create TransactionTool to create a shipping label transaction with Shippo.
Create User Parcel TemplateTool to create a new user parcel template in Shippo with preset dimensions and weight specifications.
Create Shippo WebhookTool to create a new webhook subscription in Shippo.
Delete Default Parcel TemplateTool to clear the current default parcel template.
Delete User Parcel TemplateTool to delete a user-created parcel template.
Delete WebhookTool to delete a specific webhook from Shippo.
Get AddressTool to retrieve a previously created address from Shippo.
Get Carrier AccountTool to retrieve a carrier account by its ID.
Get Carrier Parcel TemplateTool to retrieve a specific carrier parcel template by its token.
Get Carrier Registration StatusTool to retrieve carrier registration status from Shippo.
Get Customs DeclarationTool to retrieve a customs declaration by its ID.
Get customs itemTool to retrieve a customs item from Shippo.
Get Default Parcel TemplateTool to retrieve the current default parcel template for live rates at checkout.
Get MerchantTool to retrieve a merchant from the Shippo Platform API.
Get Merchant AddressTool to retrieve a merchant address from Shippo Platform API.
Get Merchant BatchTool to retrieve a batch for a merchant from the Shippo Platform API.
Get Merchant Carrier AccountTool to retrieve a carrier account for a merchant using the Shippo Platform API.
Get Merchant Carrier Registration StatusTool to retrieve carrier registration status for a specific merchant using Shippo's Platform API.
Get Merchant Customs DeclarationTool to retrieve a specific customs declaration for a merchant using Shippo's Platform API.
Get Merchant Customs ItemTool to retrieve a customs item for a merchant using the Shippo Platform API.
Get Merchant ManifestTool to retrieve a manifest for a merchant from the Shippo Platform API.
Get Merchant OrderTool to retrieve an order for a merchant from the Shippo Platform API.
Get Merchant ParcelTool to retrieve a parcel for a merchant from the Shippo Platform API.
Get Merchant RateTool to retrieve a specific shipping rate for a merchant using the Shippo Platform API.
Get Merchant RefundTool to retrieve a merchant refund from Shippo Platform API.
Get Merchant ShipmentTool to retrieve a shipment for a merchant from the Shippo Platform API.
Get Merchant Tracking StatusTool to retrieve tracking status for a merchant from Shippo Platform API.
Get Merchant TransactionTool to retrieve a shipping label transaction for a merchant from the Shippo Platform API.
Get OrderTool to retrieve an order from Shippo.
Get ParcelTool to retrieve a parcel by its ID.
Get RateTool to retrieve a specific shipping rate by its ID.
Get RefundTool to retrieve a refund by its ID from Shippo.
Get ShipmentTool to retrieve a shipment by its ID.
Get Shippo AccountTool to retrieve a Shippo Account from the Shippo Platform API.
Get Tracking StatusTool to retrieve tracking status for a shipment from Shippo.
Get TransactionTool to retrieve a shipping label transaction by its ID.
Get User Parcel TemplateTool to retrieve a specific user-created parcel template by its object ID.
Get WebhookTool to retrieve a specific webhook subscription from Shippo.
List AddressesTool to list all addresses in the Shippo account with pagination support.
List Carrier AccountsTool to list all carrier accounts configured in the Shippo account with pagination support.
List Carrier Parcel TemplatesTool to list all carrier parcel templates available for creating shipments.
List Customs DeclarationsTool to list all customs declarations in the Shippo account with pagination support.
List Customs ItemsTool to list all customs items with pagination support.
List ManifestsTool to list all shipping manifests from Shippo.
List Merchant AddressesTool to list all addresses for a specific merchant using the Shippo Platform API.
List Merchant Carrier AccountsTool to list all carrier accounts for a specific merchant using the Shippo Platform API.
List Merchant Customs DeclarationsTool to list all customs declarations for a specific merchant using the Shippo Platform API.
List Merchant Customs ItemsTool to list all customs items for a specific merchant using the Shippo Platform API.
List Merchant ManifestsTool to list all manifests for a specific merchant using Shippo's Platform API.
List Merchant ParcelsTool to list all parcels for a specific merchant using the Shippo Platform API.
List MerchantsTool to list all merchants using the Shippo Platform API with pagination support.
List Merchant Shipment Rates by CurrencyTool to retrieve available shipping rates for a merchant's shipment filtered by currency code using the Shippo Platform API.
List Merchant ShipmentsTool to list all shipments for a specific merchant using Shippo's Platform API.
List Merchant TransactionsTool to list all shipping label transactions for a merchant using the Shippo Platform API.
List OrdersTool to list all orders in the Shippo account with pagination support.
List RefundsTool to retrieve a list of all refunds from Shippo.
List Service GroupsTool to retrieve all service groups configured in Shippo.
List Shipment RatesTool to retrieve available shipping rates for a specific shipment.
List Shipment Rates by CurrencyTool to retrieve available shipping rates for a specific shipment filtered by currency code.
List ShipmentsTool to list all shipments in the Shippo account with pagination support.
List Shippo AccountsTool to list all Managed Shippo Accounts.
List User Parcel TemplatesTool to list all user-created parcel templates.
Purchase Merchant BatchTool to purchase a batch for a merchant via the Shippo Platform API.
Remove Shipments From BatchTool to remove shipments from a batch for a merchant using the Shippo Platform API.
Update Carrier AccountTool to update an existing carrier account in Shippo.
Update Default Parcel TemplateTool to update the default parcel template for live rates at checkout in Shippo.
Update MerchantTool to update an existing merchant in Shippo Platform API.
Update Merchant Carrier AccountTool to update a carrier account for a merchant in Shippo Platform API.
Update Service GroupTool to update an existing Shippo service group.
Update User Parcel TemplateTool to update an existing user parcel template with new weight and carrier template settings.
Update WebhookTool to update an existing webhook in Shippo.
Validate AddressTool to validate an address using the Shippo API.
Validate Merchant AddressTool to validate a merchant address using the Shippo Platform API.

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

What is Tool Router?

Composio's Tool Router helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Tool Router

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

How the Tool Router works

The Tool Router follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Prerequisites

Before starting, make sure you have:
  • Node.js 18 or higher
  • A Composio account with an active API key
  • An OpenAI API key
  • Basic familiarity with TypeScript

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key.
  • You need credits or a connected billing setup to use the models.
  • Store the key somewhere safe.
Composio API Key
  • Log in to the Composio dashboard.
  • Go to Settings and copy your API key.
  • This key lets your Mastra agent talk to Composio and reach Shippo through MCP.

Install dependencies

bash
npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv

Install the required packages.

What's happening:

  • @composio/core is the Composio SDK for creating MCP sessions
  • @mastra/core provides the Agent class
  • @mastra/mcp is Mastra's MCP client
  • @ai-sdk/openai is the model wrapper for OpenAI
  • dotenv loads environment variables from .env

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
COMPOSIO_USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key_here

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your requests to Composio
  • COMPOSIO_USER_ID tells Composio which user this session belongs to
  • OPENAI_API_KEY lets the Mastra agent call OpenAI models

Import libraries and validate environment

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

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

const composio = new Composio({
  apiKey: composioAPIKey as string,
});
What's happening:
  • dotenv/config auto loads your .env so process.env.* is available
  • openai gives you a Mastra compatible model wrapper
  • Agent is the Mastra agent that will call tools and produce answers
  • MCPClient connects Mastra to your Composio MCP server
  • Composio is used to create a Tool Router session

Create a Tool Router session for Shippo

typescript
async function main() {
  const session = await composio.create(
    composioUserID as string,
    {
      toolkits: ["shippo"],
    },
  );

  const composioMCPUrl = session.mcp.url;
  console.log("Shippo MCP URL:", composioMCPUrl);
What's happening:
  • create spins up a short-lived MCP HTTP endpoint for this user
  • The toolkits array contains "shippo" for Shippo access
  • session.mcp.url is the MCP URL that Mastra's MCPClient will connect to

Configure Mastra MCP client and fetch tools

typescript
const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      nasdaq: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

console.log("Fetching MCP tools from Composio...");
const composioTools = await mcpClient.getTools();
console.log("Number of tools:", Object.keys(composioTools).length);
What's happening:
  • MCPClient takes an id for this client and a list of MCP servers
  • The headers property includes the x-api-key for authentication
  • getTools fetches the tool definitions exposed by the Shippo toolkit

Create the Mastra agent

typescript
const agent = new Agent({
    name: "shippo-mastra-agent",
    instructions: "You are an AI agent with Shippo tools via Composio.",
    model: "openai/gpt-5",
  });
What's happening:
  • Agent is the core Mastra agent
  • name is just an identifier for logging and debugging
  • instructions guide the agent to use tools instead of only answering in natural language
  • model uses openai("gpt-5") to configure the underlying LLM

Set up interactive chat interface

typescript
let messages: AiMessageType[] = [];

console.log("Chat started! Type 'exit' or 'quit' to end.\n");

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: "> ",
});

rl.prompt();

rl.on("line", async (userInput: string) => {
  const trimmedInput = userInput.trim();

  if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) {
    console.log("\nGoodbye!");
    rl.close();
    process.exit(0);
  }

  if (!trimmedInput) {
    rl.prompt();
    return;
  }

  messages.push({
    id: crypto.randomUUID(),
    role: "user",
    content: trimmedInput,
  });

  console.log("\nAgent is thinking...\n");

  try {
    const response = await agent.generate(messages, {
      toolsets: {
        shippo: composioTools,
      },
      maxSteps: 8,
    });

    const { text } = response;

    if (text && text.trim().length > 0) {
      console.log(`Agent: ${text}\n`);
        messages.push({
          id: crypto.randomUUID(),
          role: "assistant",
          content: text,
        });
      }
    } catch (error) {
      console.error("\nError:", error);
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    console.log("\nSession ended.");
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main().catch((err) => {
  console.error("Fatal error:", err);
  process.exit(1);
});
What's happening:
  • messages keeps the full conversation history in Mastra's expected format
  • agent.generate runs the agent with conversation history and Shippo toolsets
  • maxSteps limits how many tool calls the agent can take in a single run
  • onStepFinish is a hook that prints intermediate steps for debugging

Complete Code

Here's the complete code to get you started with Shippo and Mastra AI:

typescript
import "dotenv/config";
import { openai } from "@ai-sdk/openai";
import { Agent } from "@mastra/core/agent";
import { MCPClient } from "@mastra/mcp";
import { Composio } from "@composio/core";
import * as readline from "readline";

import type { AiMessageType } from "@mastra/core/agent";

const openaiAPIKey = process.env.OPENAI_API_KEY;
const composioAPIKey = process.env.COMPOSIO_API_KEY;
const composioUserID = process.env.COMPOSIO_USER_ID;

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

const composio = new Composio({ apiKey: composioAPIKey as string });

async function main() {
  const session = await composio.create(composioUserID as string, {
    toolkits: ["shippo"],
  });

  const composioMCPUrl = session.mcp.url;

  const mcpClient = new MCPClient({
    id: composioUserID as string,
    servers: {
      shippo: {
        url: new URL(composioMCPUrl),
        requestInit: {
          headers: session.mcp.headers,
        },
      },
    },
    timeout: 30_000,
  });

  const composioTools = await mcpClient.getTools();

  const agent = new Agent({
    name: "shippo-mastra-agent",
    instructions: "You are an AI agent with Shippo tools via Composio.",
    model: "openai/gpt-5",
  });

  let messages: AiMessageType[] = [];

  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: "> ",
  });

  rl.prompt();

  rl.on("line", async (input: string) => {
    const trimmed = input.trim();
    if (["exit", "quit"].includes(trimmed.toLowerCase())) {
      rl.close();
      return;
    }

    messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed });

    const { text } = await agent.generate(messages, {
      toolsets: { shippo: composioTools },
      maxSteps: 8,
    });

    if (text) {
      console.log(`Agent: ${text}\n`);
      messages.push({ id: crypto.randomUUID(), role: "assistant", content: text });
    }

    rl.prompt();
  });

  rl.on("close", async () => {
    await mcpClient.disconnect();
    process.exit(0);
  });
}

main();

Conclusion

You've built a Mastra AI agent that can interact with Shippo through Composio's Tool Router. You can extend this further by:
  • Adding other toolkits like Gmail, Slack, or GitHub
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows

How to build Shippo MCP Agent with another framework

OpenAI Agents SDK

OpenAI Agents SDK

Use Shippo MCP with OpenAI Agents SDK

Claude Agent SDK

Claude Agent SDK

Use Shippo MCP with Claude Agent SDK

Google ADK

Google ADK

Use Shippo MCP with Google ADK

LangChain

LangChain

Use Shippo MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Shippo MCP with Vercel AI SDK

LlamaIndex

LlamaIndex

Use Shippo MCP with LlamaIndex

CrewAI

CrewAI

Use Shippo MCP with CrewAI

Claude Code

Claude Code

Use Shippo MCP with Claude Code

Codex

Codex

Use Shippo MCP with Codex

FAQ

What are the differences in Tool Router MCP and Shippo MCP?

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.

Can I use Tool Router MCP with Mastra AI?

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

Can I manage the permissions and scopes for Shippo while using Tool Router?

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.

How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Shippo data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Book a call↗Get started for free