How to integrate Shipengine MCP with OpenAI Agents SDK

This guide walks you through connecting Shipengine to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Shipengine agent that can generate shipping label for new order, track status of outgoing packages, validate customer address before shipping through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Shipengine account through Composio's Shipengine MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Get started for freeGet a demo
Shipengine logoShipengine
Api Key

ShipEngine is a shipping API that connects with multiple carriers to manage shipments, labels, and tracking. Streamline your shipping process and reduce manual effort with one unified tool.

66 Tools

Introduction

This guide walks you through connecting Shipengine to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Shipengine agent that can generate shipping label for new order, track status of outgoing packages, validate customer address before shipping through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Shipengine account through Composio's Shipengine MCP server.

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

Also integrate Shipengine with

Claude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Shipengine
  • Configure an AI agent that can use Shipengine as a tool
  • Run a live chat session where you can ask the agent to perform Shipengine operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

What is the Shipengine MCP server, and what's possible with it?

The Shipengine MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Shipengine account. It provides structured and secure access to your shipping operations, so your agent can perform actions like generating shipping labels, tracking packages, validating addresses, and managing carrier integrations on your behalf.

  • Automated label creation and management: Instantly generate, purchase, and void shipping labels across multiple carriers, letting your agent streamline fulfillment without manual entry.
  • Real-time package tracking: Ask your agent to track shipments by carrier or tracking number to get up-to-date delivery statuses and shipment histories.
  • Address validation and correction: Have your agent validate and standardize shipment addresses to prevent delivery errors and reduce returns.
  • Carrier rate comparison: Enable your agent to fetch and compare real-time shipping rates from all connected carriers, helping you save on delivery costs.
  • Shipping manifest and batch processing: Let your agent generate manifests or process batches of shipments in a single command, making high-volume shipping fast and efficient.

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 step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Shipengine project
  • Some knowledge of Python or Typescript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Shipengine.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Shipengine
const session = await composio.create(userId as string, {
  toolkits: ['shipengine'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only shipengine.
  • The router checks the user's Shipengine connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Shipengine.
  • This approach keeps things lightweight and lets the agent request Shipengine tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Shipengine. Help users perform Shipengine operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Shipengine and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Shipengine operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

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

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Shipengine.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Shipengine and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['shipengine'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Shipengine. Help users perform Shipengine operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

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

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

This was a starter code for integrating Shipengine MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Shipengine.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
TOOLS

Supported Tools

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

Add Tag to Shipment

Tool to add a tag to a shipment for organization and filtering.

Add to Batch

Tool to add shipments or rate IDs to an existing batch.

Cancel Shipment

Tool to cancel a shipment by ID.

Connect LTL Carrier

Tool to connect an LTL carrier account to ShipEngine.

Connect Shipsurance Account

Tool to connect a Shipsurance insurance account to ShipEngine.

Create Account Image

Tool to create a new account image in ShipEngine.

Create Package Type

Tool to create a custom package type definition in ShipEngine.

Create Tag

Tool to create a new tag in ShipEngine.

Create Tag 2

Tool to create a new tag for organizing shipments.

Create Warehouse

Tool to create a new warehouse.

Create Webhook

Tool to create a ShipEngine webhook.

Delete Account Image by ID

Tool to delete a ShipEngine account image by its ID.

Delete Batch

Tool to delete a batch by ID.

Delete Package

Tool to delete a custom package type by ID.

Delete Warehouse

Tool to delete a warehouse from your ShipEngine account.

Delete Webhook

Tool to delete a ShipEngine webhook subscription.

Disconnect Carrier

Tool to disconnect a carrier account from ShipEngine.

Disconnect Shipsurance

Tool to disconnect a Shipsurance insurance account from ShipEngine.

Download File

Tool to download a file from ShipEngine.

Get Account Image by ID

Tool to retrieve account image settings by label image ID.

Get Batch by External ID

Tool to retrieve batch details using an external batch ID.

Get Batch by ID

Tool to retrieve detailed information about a specific batch by its ID.

Get Batch Errors

Tool to retrieve errors that occurred during batch processing.

Get Bulk Rates

Tool to get shipping rates for multiple shipments in a single request.

Get Insurance Balance

Tool to retrieve the current Shipsurance insurance funds balance.

Get LTL Carrier Credential Requirements

Tool to retrieve credential requirements for connecting an LTL carrier.

Get LTL Carrier Features

Tool to retrieve features supported by an LTL carrier.

Get LTL Carrier Options

Tool to list available options/accessorials for an LTL carrier.

Get LTL Carrier Packages

Tool to list available package/handling unit types for an LTL (Less Than Truckload) carrier.

Get LTL Carrier Services

Tool to list available services for an LTL carrier.

Get Package by ID

Tool to get details of a specific custom package type by ID.

Get Shipment by External ID

Tool to retrieve shipment details using an external shipment ID.

Get Shipment by ID

Tool to retrieve a shipment by ID.

Get Shipment Rates

Tool to retrieve shipping rates for an existing shipment.

Get Tracking Information

Tool to retrieve tracking information for a shipment.

Get Warehouse by ID

Tool to retrieve details of a specific warehouse by ID.

Get Webhook by ID

Tool to retrieve details of a specific webhook by ID.

List Account Images

Tool to list all account images.

List Account Settings

Tool to list all account settings for the ShipEngine account.

List Batches (v2)

Tool to list all batches with comprehensive filtering options.

List Carrier Package Types

Tool to list all available package types for a specific carrier.

List Labels (Extended)

Tool to list all shipping labels with comprehensive filtering options.

List LTL Carriers

Tool to list all LTL (Less-Than-Truckload) carrier accounts connected to your ShipEngine account.

List Manifests (Advanced)

Tool to list all manifests with optional filtering by warehouse and carrier.

List Packages

Tool to list all package types.

List Scheduled Pickups

Tool to list all scheduled pickups with optional filters.

List Shipments (v2)

Tool to list all shipments with optional filtering parameters.

List Tags (v2)

Tool to list all tags in your account.

List Warehouses

Tool to list all warehouses.

List Webhook Events

Retrieve a list of available webhook event types supported by ShipEngine.

List Webhooks

Tool to list all webhooks configured on your account.

Parse Address

Tool to parse unstructured address text and extract structured address components.

Process Batch Labels

Tool to process a batch to create and purchase shipping labels for all shipments in the batch.

Remove From Batch

Tool to remove shipments or rate IDs from a batch.

Remove Tag from Shipment

Tool to remove a tag from a shipment.

Start Tracking Package

Tool to subscribe to tracking updates for a package via webhooks.

Stop Tracking Package

Tool to unsubscribe from tracking updates for a package.

Track LTL Shipment

Tool to track an LTL shipment using carrier code and PRO number.

Update Account Image By ID

Tool to update an account image by ID in ShipEngine.

Update LTL Connection

Tool to update LTL carrier connection credentials in ShipEngine.

Update Package Type

Tool to update an existing custom package type definition.

Update Shipment

Tool to update an existing shipment's details.

Update Shipments Tags

Tool to update tags on one or more shipments in bulk.

Update Warehouse

Tool to update an existing warehouse's details and address.

Update Webhook

Tool to update a ShipEngine webhook.

Validate Address

Tool to validate and normalize shipping addresses.

FRAMEWORKS

How to build Shipengine MCP Agent with another framework

Claude Agent SDK logo

Claude Agent SDK

Use Shipengine MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Shipengine MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Shipengine MCP with Claude Cowork

Codex logo

Codex

Use Shipengine MCP with Codex

OpenClaw logo

OpenClaw

Use Shipengine MCP with OpenClaw

Hermes logo

Hermes

Use Shipengine MCP with Hermes

CLI logo

CLI

Use Shipengine MCP with CLI

Google ADK logo

Google ADK

Use Shipengine MCP with Google ADK

LangChain logo

LangChain

Use Shipengine MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Shipengine MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Shipengine MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Shipengine MCP with LlamaIndex

CrewAI logo

CrewAI

Use Shipengine MCP with CrewAI

FAQ

Frequently asked questions

With a standalone Shipengine MCP server, the agents and LLMs can only access a fixed set of Shipengine tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Shipengine and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. OpenAI Agents SDK 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 Shipengine tools.

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

Start with Shipengine.It takes 30 seconds.

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

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

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

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

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

Abhi Arya
Abhi Arya
Co-founder, Opennote

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

Nirman Dave
Nirman Dave
CEO, Zams

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

Ryan Yu
Ryan Yu
Founder, Extra Thursday

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

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

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

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies