How to integrate Route4me MCP with LlamaIndex

Trusted by
AWS
Glean
Zoom
Airtable

30 min · no commitment · see it on your stack

Route4me logo
LlamaIndex logo
divider

Introduction

This guide walks you through connecting Route4me to LlamaIndex 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 LlamaIndex 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:
  • Set your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for Route4me
  • Connect LlamaIndex to the Route4me MCP server
  • Build a Route4me-powered agent using LlamaIndex
  • Interact with Route4me 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 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 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 Route4me account and project
  • Basic familiarity with async Python/Typescript

Getting API Keys for OpenAI, Composio, and Route4me

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

Installing dependencies

pip install composio-llamaindex llama-index llama-index-llms-openai llama-index-tools-mcp python-dotenv

Create a new Python project and install the necessary dependencies:

  • composio-llamaindex: Composio's LlamaIndex integration
  • llama-index: Core LlamaIndex framework
  • llama-index-llms-openai: OpenAI LLM integration
  • llama-index-tools-mcp: MCP client for LlamaIndex
  • python-dotenv: Environment variable management

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

Import modules

import asyncio
import os
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()

Create a new file called route4me_llamaindex_agent.py and import the required modules:

Key imports:

  • asyncio: For async/await support
  • Composio: Main client for Composio services
  • LlamaIndexProvider: Adapts Composio tools for LlamaIndex
  • ReActAgent: LlamaIndex's reasoning and action agent
  • BasicMCPClient: Connects to MCP endpoints
  • McpToolSpec: Converts MCP tools to LlamaIndex format

Load environment variables and initialize Composio

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set in the environment")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set in the environment")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set in the environment")

What's happening:

This ensures missing credentials cause early, clear errors before the agent attempts to initialise.

Create a Tool Router session and build the agent function

async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["route4me"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")

    description = "An agent that uses Composio Tool Router MCP tools to perform Route4me actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Route4me actions.
    """
    return ReActAgent(tools=tools, llm=llm, description=description, system_prompt=system_prompt, verbose=True)

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, route4me)
  • 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 Route4me tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.

Create an interactive chat loop

async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")

What's happening here:

  • We're creating a direct terminal interface to chat with your Route4me database
  • The LLM's responses are streamed to the CLI for faster interaction.
  • The agent uses context to maintain conversation history
  • You can type 'quit' or 'exit' to stop the chat loop gracefully
  • Agent responses and any errors are displayed in a clear, readable format

Define the main entry point

async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")

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 Route4me

Run the agent

npx ts-node llamaindex-agent.ts

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

Complete Code

Here's the complete code to get you started with Route4me and LlamaIndex:

import asyncio
import os
import signal
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set")

async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["route4me"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")
    description = "An agent that uses Composio Tool Router MCP tools to perform Route4me actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Route4me actions.
    """
    return ReActAgent(
        tools=tools,
        llm=llm,
        description=description,
        system_prompt=system_prompt,
        verbose=True,
    );

async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")

async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")

Conclusion

You've successfully connected Route4me to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Route4me 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.

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 LlamaIndex?

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