How to integrate Route4me MCP with OpenAI Agents SDK

This guide walks you through connecting Route4me to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Route4me agent that can list all available delivery vehicles today, mark stop 12 on route 8 as completed, show vehicles with capacity over 1000 lbs through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Route4me account through Composio's Route4me 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
Route4me logoRoute4me
Api Key

Route4Me is a Last Mile Routing API that automates route planning for logistics teams. It helps businesses save time and fuel with optimized, real-time delivery routes.

97 Tools

Introduction

This guide walks you through connecting Route4me to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Route4me agent that can list all available delivery vehicles today, mark stop 12 on route 8 as completed, show vehicles with capacity over 1000 lbs through natural language commands.

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

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

Also integrate Route4me 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 Route4me
  • Configure an AI agent that can use Route4me as a tool
  • Run a live chat session where you can ask the agent to perform Route4me 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 Route4me MCP server, and what's possible with it?

The Route4me MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Route4me account. It provides structured and secure access to your fleet and route data, so your agent can perform actions like listing vehicles, retrieving asset details, updating destination statuses, and streamlining last-mile logistics on your behalf.

  • Full vehicle inventory retrieval: Instantly ask your agent to pull a complete list of all vehicles in your organization for planning and operational audits.
  • Vehicle data access for route planning: Get detailed information on each vehicle—including capacity and assignment details—to optimize delivery routes.
  • Automated destination status updates: Let your agent mark destinations as completed, skipped, or failed after deliveries or stops, keeping your records accurate in real time.
  • Streamlined delivery confirmation workflows: Have your agent confirm delivery outcomes automatically, ensuring your route progress is always up to date for dispatchers and drivers.

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 Route4me 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 Route4me.
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 Route4me
const session = await composio.create(userId as string, {
  toolkits: ['route4me'],
});
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 route4me.
  • The router checks the user's Route4me connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Route4me.
  • This approach keeps things lightweight and lets the agent request Route4me 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 Route4me. Help users perform Route4me 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 Route4me 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 Route4me 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 Route4me.
  • 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 Route4me 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: ['route4me'],
  });
  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 Route4me. Help users perform Route4me 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 Route4me MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Route4me.

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 Route4me action and event your agent gets out of the box.

Add Order Custom Field

Tool to add a new custom field definition for orders.

Add Route Note

Tool to add a note to a route or address destination.

Create Address

Tool to add a new address to the address book.

Create Avoidance Zone

Tool to create an avoidance zone with circular, rectangular, or polygon shape.

Create Location Type

Tool to create a new location type in the address book.

Create Master Route

Tool to create a new master route in Route4Me.

Create Custom Note Type

Tool to create a new custom note type in Route4me.

Create Route Optimization

Tool to create a new route optimization in Route4Me.

Create Optimization Profile

Tool to create a new optimization profile in Route4Me.

Create Order Custom Field

Tool to create a new custom field definition for orders.

Create Orders from Contacts

Tool to create orders from address book contacts.

Create Territory

Tool to create a new territory with circular, rectangular, or polygon shape.

Create Vehicle Capacity Profile

Tool to create a vehicle capacity profile with weight, volume, item count, and revenue limits.

Delete Address from Route

Tool to delete an address from a route.

Delete Addresses

Tool to delete addresses from the Route4Me address book.

Delete Avoidance Zone

Tool to delete an avoidance zone by territory_id.

Delete Configuration Setting

Tool to delete a member configuration setting by config_key.

Delete Current User

Tool to delete the current authenticated user account.

Delete Location Type

Tool to delete a location type from the address book.

Delete Optimization

Tool to remove optimization problems from the Route4Me database.

Delete Optimization Profile

Tool to delete an optimization profile by ID.

Delete Order Custom Field

Tool to delete an order custom field by ID.

Delete Route V4

Tool to delete one or more routes by route_id.

Delete Territory

Tool to delete a territory by territory_id.

Delete Vehicle Capacity Profile by ID

Tool to delete a vehicle capacity profile by ID.

Dispatch Routes

Tool to approve or revoke routes for execution in Route4Me.

Display Datatable Config

Tool to retrieve datatable configuration for vehicle capacity profiles.

Duplicate Routes

Tool to duplicate one or more existing routes.

Find Address

Tool to retrieve detailed information about a specific address from the Route4Me address book.

Geocode Address

Tool to geocode an address and obtain its coordinates.

Geocode Address (Body)

Tool to geocode an address by sending a body payload with the address and options.

Bulk Geocode Addresses

Tool to geocode multiple addresses in a single request.

Geocode Address Forward

Tool to convert an address to geographic coordinates using forward geocoding.

Get Activity Feed

Tool to retrieve activities from the Route4Me activity feed with optional filtering and pagination.

Get Address

Tool to get address/destination information from a route.

Get Address Book Groups

Tool to retrieve address book groups from Route4Me.

Get Addresses from Address Book

Tool to retrieve addresses from the Route4Me address book.

Get Async Export Tracking History

Tool to save tracking history file via async export.

Get All Territories (Avoidance Zones v5)

Tool to retrieve all avoidance zones (territories) using API v5.

Get Avoidance Zone By ID

Tool to retrieve a specific avoidance zone by its territory ID.

Get Clustered Locations

Tool to retrieve locations grouped by geographic proximity using geohash clustering.

Get Current Member Information

Tool to retrieve the current authenticated member's information.

Get Activity Feed

Tool to retrieve all activities from the Route4Me activity feed.

Get Last Scheduled Route for Member

Tool to retrieve the most recently scheduled route for a specific member as of today.

Get Location Heatmap

Tool to retrieve a heat map of location clusters from the address book.

Get Location Service-Time Heatmap

Tool to retrieve location service-time heatmap data for address book locations.

Get Location Type

Tool to get location type details by ID.

Get Member Configuration Settings

Tool to get member configuration settings with optional filtering.

Get Note Custom Types

Tool to retrieve all custom note types configured for the account.

Get Optimization Profile

Tool to retrieve detailed information about an optimization profile by its unique identifier.

Get Route Destination By ID

Tool to get a route address/destination by its ID.

Get Route Info

Tool to get detailed route information by route ID.

Get Route List

Tool to retrieve a list of routes with filtering and pagination.

Get Route Settings

Tool to get route settings with detailed information including waypoints, optimization settings, and delivery details.

Get Territories with Location Counts

Tool to retrieve territories with location counts for geographic analysis.

Get Territory

Tool to retrieve territory information by ID or get all territories.

Submit Device Tracking Data

Tool to submit device GPS tracking information to Route4Me.

Get Tracking History Export

Tool to export tracking history file from Route4Me.

Get User By ID

Tool to retrieve a sub-user by their unique ID.

Get User Locations

Tool to view locations of all users/drivers in real-time.

Get User Modification History

Tool to get user modification history from Route4Me.

Get User Template

Tool to retrieve the template of a sub-user with detailed information including contact information, preferences, and account status.

Get User Information (v4)

Tool to retrieve authenticated user information in v4 format.

Get Vehicles

Tool to retrieve details of vehicles in the organization.

Get Vehicle Capacity Profile As Datatable

Tool to retrieve vehicle capacity profiles in datatable format with pagination.

Get Vehicle Capacity Profile by ID

Tool to retrieve a specific vehicle capacity profile by its ID.

Get Vehicle Capacity Profile Page Config

Tool to retrieve vehicle capacity profile page configuration including unit settings.

Get Vehicle Capacity Profiles

Tool to retrieve vehicle capacity profiles with weight, volume, and item constraints.

List Location Types

Tool to retrieve location type definitions used in the address book system.

List Optimization Profiles

Tool to retrieve optimization profiles with settings and configuration details.

List Optimizations

Tool to get a list of all optimizations or retrieve a single optimization by ID.

List Order Custom Fields

Tool to retrieve all order custom field definitions from Route4Me v5.

List Route Directions

Tool to get detailed route directions including turn-by-turn navigation information for each stop.

List Team Users

Tool to get the list of team members/users in the account.

List Users By IDs

Tool to retrieve detailed information about team members by their member IDs.

List Team Users (Paginated)

Tool to get a paginated list of team members/users in the account.

Lookup For New Destination

Tool to lookup optimal routes for inserting a new destination.

Merge Routes

Tool to merge multiple routes into a single target route.

Move Route Destination

Tool to move a destination from one route to another.

Preview Route Assignment

Tool to generate a preview of route assignments based on filters, grouping, sorting, and assignment strategy without applying changes.

Re-run Optimization

Tool to re-optimize an existing optimization problem by updating route parameters and/or addresses.

Reverse Geocode Address

Tool to reverse geocode coordinates to obtain an address.

Set Destination Status

Tool to set or update the status of a route destination.

Set Route Rating

Tool to set a rating for a route.

Set Route Tracking Data

Tool to insert tracking data for a route.

Update Address

Tool to update an existing address in the Route4Me address book.

Update Avoidance Zone

Tool to update an existing avoidance zone.

Update Location Type

Tool to update an existing location type in the address book.

Update Member Configuration Setting

Tool to update a member configuration setting.

Update Custom Note Type

Tool to update an existing custom note type in Route4Me.

Update Optimization Profile

Tool to update an existing optimization profile.

Update Order Custom Field

Tool to update an existing order custom field in Route4Me.

Update Routes

Tool to bulk update multiple routes in a single operation.

Update Route Settings

Tool to update route settings including optimization parameters, distance units, and device types.

Update Route V4

Tool to update route parameters and addresses in Route4Me.

Update Territory

Tool to update an existing territory.

Update Vehicle Capacity Profile By ID

Tool to update an existing vehicle capacity profile by ID.

FRAMEWORKS

How to build Route4me MCP Agent with another framework

Claude Agent SDK logo

Claude Agent SDK

Use Route4me MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Route4me MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Route4me MCP with Claude Cowork

Codex logo

Codex

Use Route4me MCP with Codex

OpenClaw logo

OpenClaw

Use Route4me MCP with OpenClaw

Hermes logo

Hermes

Use Route4me MCP with Hermes

CLI logo

CLI

Use Route4me MCP with CLI

Google ADK logo

Google ADK

Use Route4me MCP with Google ADK

LangChain logo

LangChain

Use Route4me MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Route4me MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Route4me MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Route4me MCP with LlamaIndex

CrewAI logo

CrewAI

Use Route4me MCP with CrewAI

FAQ

Frequently asked questions

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

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

Start with Route4me.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Route4me 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