How to integrate Route4me MCP with OpenAI Agents SDK

Trusted by
AWS
Glean
Zoom
Airtable

30 min · no commitment · see it on your stack

Route4me logo
OpenAI Agents SDK logo
divider

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

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.

Supported Tools & Triggers

Tools
Add Order Custom FieldTool to add a new custom field definition for orders.
Add Route NoteTool to add a note to a route or address destination.
Create AddressTool to add a new address to the address book.
Create Avoidance ZoneTool to create an avoidance zone with circular, rectangular, or polygon shape.
Create Location TypeTool to create a new location type in the address book.
Create Master RouteTool to create a new master route in Route4Me.
Create Custom Note TypeTool to create a new custom note type in Route4me.
Create Route OptimizationTool to create a new route optimization in Route4Me.
Create Optimization ProfileTool to create a new optimization profile in Route4Me.
Create Order Custom FieldTool to create a new custom field definition for orders.
Create Orders from ContactsTool to create orders from address book contacts.
Create TerritoryTool to create a new territory with circular, rectangular, or polygon shape.
Create Vehicle Capacity ProfileTool to create a vehicle capacity profile with weight, volume, item count, and revenue limits.
Delete Address from RouteTool to delete an address from a route.
Delete AddressesTool to delete addresses from the Route4Me address book.
Delete Avoidance ZoneTool to delete an avoidance zone by territory_id.
Delete Configuration SettingTool to delete a member configuration setting by config_key.
Delete Current UserTool to delete the current authenticated user account.
Delete Location TypeTool to delete a location type from the address book.
Delete OptimizationTool to remove optimization problems from the Route4Me database.
Delete Optimization ProfileTool to delete an optimization profile by ID.
Delete Order Custom FieldTool to delete an order custom field by ID.
Delete Route V4Tool to delete one or more routes by route_id.
Delete TerritoryTool to delete a territory by territory_id.
Delete Vehicle Capacity Profile by IDTool to delete a vehicle capacity profile by ID.
Dispatch RoutesTool to approve or revoke routes for execution in Route4Me.
Display Datatable ConfigTool to retrieve datatable configuration for vehicle capacity profiles.
Duplicate RoutesTool to duplicate one or more existing routes.
Find AddressTool to retrieve detailed information about a specific address from the Route4Me address book.
Geocode AddressTool 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 AddressesTool to geocode multiple addresses in a single request.
Geocode Address ForwardTool to convert an address to geographic coordinates using forward geocoding.
Get Activity FeedTool to retrieve activities from the Route4Me activity feed with optional filtering and pagination.
Get AddressTool to get address/destination information from a route.
Get Address Book GroupsTool to retrieve address book groups from Route4Me.
Get Addresses from Address BookTool to retrieve addresses from the Route4Me address book.
Get Async Export Tracking HistoryTool 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 IDTool to retrieve a specific avoidance zone by its territory ID.
Get Clustered LocationsTool to retrieve locations grouped by geographic proximity using geohash clustering.
Get Current Member InformationTool to retrieve the current authenticated member's information.
Get Activity FeedTool to retrieve all activities from the Route4Me activity feed.
Get Last Scheduled Route for MemberTool to retrieve the most recently scheduled route for a specific member as of today.
Get Location HeatmapTool to retrieve a heat map of location clusters from the address book.
Get Location Service-Time HeatmapTool to retrieve location service-time heatmap data for address book locations.
Get Location TypeTool to get location type details by ID.
Get Member Configuration SettingsTool to get member configuration settings with optional filtering.
Get Note Custom TypesTool to retrieve all custom note types configured for the account.
Get Optimization ProfileTool to retrieve detailed information about an optimization profile by its unique identifier.
Get Route Destination By IDTool to get a route address/destination by its ID.
Get Route InfoTool to get detailed route information by route ID.
Get Route ListTool to retrieve a list of routes with filtering and pagination.
Get Route SettingsTool to get route settings with detailed information including waypoints, optimization settings, and delivery details.
Get Territories with Location CountsTool to retrieve territories with location counts for geographic analysis.
Get TerritoryTool to retrieve territory information by ID or get all territories.
Submit Device Tracking DataTool to submit device GPS tracking information to Route4Me.
Get Tracking History ExportTool to export tracking history file from Route4Me.
Get User By IDTool to retrieve a sub-user by their unique ID.
Get User LocationsTool to view locations of all users/drivers in real-time.
Get User Modification HistoryTool to get user modification history from Route4Me.
Get User TemplateTool 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 VehiclesTool to retrieve details of vehicles in the organization.
Get Vehicle Capacity Profile As DatatableTool to retrieve vehicle capacity profiles in datatable format with pagination.
Get Vehicle Capacity Profile by IDTool to retrieve a specific vehicle capacity profile by its ID.
Get Vehicle Capacity Profile Page ConfigTool to retrieve vehicle capacity profile page configuration including unit settings.
Get Vehicle Capacity ProfilesTool to retrieve vehicle capacity profiles with weight, volume, and item constraints.
List Location TypesTool to retrieve location type definitions used in the address book system.
List Optimization ProfilesTool to retrieve optimization profiles with settings and configuration details.
List OptimizationsTool to get a list of all optimizations or retrieve a single optimization by ID.
List Order Custom FieldsTool to retrieve all order custom field definitions from Route4Me v5.
List Route DirectionsTool to get detailed route directions including turn-by-turn navigation information for each stop.
List Team UsersTool to get the list of team members/users in the account.
List Users By IDsTool 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 DestinationTool to lookup optimal routes for inserting a new destination.
Merge RoutesTool to merge multiple routes into a single target route.
Move Route DestinationTool to move a destination from one route to another.
Preview Route AssignmentTool to generate a preview of route assignments based on filters, grouping, sorting, and assignment strategy without applying changes.
Re-run OptimizationTool to re-optimize an existing optimization problem by updating route parameters and/or addresses.
Reverse Geocode AddressTool to reverse geocode coordinates to obtain an address.
Set Destination StatusTool to set or update the status of a route destination.
Set Route RatingTool to set a rating for a route.
Set Route Tracking DataTool to insert tracking data for a route.
Update AddressTool to update an existing address in the Route4Me address book.
Update Avoidance ZoneTool to update an existing avoidance zone.
Update Location TypeTool to update an existing location type in the address book.
Update Member Configuration SettingTool to update a member configuration setting.
Update Custom Note TypeTool to update an existing custom note type in Route4Me.
Update Optimization ProfileTool to update an existing optimization profile.
Update Order Custom FieldTool to update an existing order custom field in Route4Me.
Update RoutesTool to bulk update multiple routes in a single operation.
Update Route SettingsTool to update route settings including optimization parameters, distance units, and device types.
Update Route V4Tool to update route parameters and addresses in Route4Me.
Update TerritoryTool to update an existing territory.
Update Vehicle Capacity Profile By IDTool to update an existing vehicle capacity profile by ID.

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

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

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

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

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.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
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.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Route4me Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["route4me"]
)

mcp_url = 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.

Configure the agent

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "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 dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Route4me operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
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 Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • 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 asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["route4me"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

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.

How to build Route4me MCP Agent with another framework

FAQ

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

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.

Can I use Tool Router MCP with OpenAI Agents SDK?

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.

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

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.

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 Route4me 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.