# How to integrate Optimoroute MCP with Autogen ```json { "title": "How to integrate Optimoroute MCP with Autogen", "toolkit": "Optimoroute", "toolkit_slug": "optimoroute", "framework": "AutoGen", "framework_slug": "autogen", "url": "https://composio.dev/toolkits/optimoroute/framework/autogen", "markdown_url": "https://composio.dev/toolkits/optimoroute/framework/autogen.md", "updated_at": "2026-05-12T10:21:00.158Z" } ``` ## Introduction This guide walks you through connecting Optimoroute to AutoGen using the Composio tool router. By the end, you'll have a working Optimoroute agent that can list all active drivers on duty today, show planned delivery routes for tomorrow, find unassigned orders for this week through natural language commands. This guide will help you understand how to give your AutoGen agent real control over a Optimoroute account through Composio's Optimoroute MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Optimoroute with - [OpenAI Agents SDK](https://composio.dev/toolkits/optimoroute/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/optimoroute/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/optimoroute/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/optimoroute/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/optimoroute/framework/codex) - [OpenClaw](https://composio.dev/toolkits/optimoroute/framework/openclaw) - [Hermes](https://composio.dev/toolkits/optimoroute/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/optimoroute/framework/cli) - [Google ADK](https://composio.dev/toolkits/optimoroute/framework/google-adk) - [LangChain](https://composio.dev/toolkits/optimoroute/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/optimoroute/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/optimoroute/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/optimoroute/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/optimoroute/framework/crew-ai) ## TL;DR Here's what you'll learn: - Get and set up your OpenAI and Composio API keys - Install the required dependencies for Autogen and Composio - Initialize Composio and create a Tool Router session for Optimoroute - Wire that MCP URL into Autogen using McpWorkbench and StreamableHttpServerParams - Configure an Autogen AssistantAgent that can call Optimoroute tools - Run a live chat loop where you ask the agent to perform Optimoroute operations ## What is AutoGen? Autogen is a framework for building multi-agent conversational AI systems from Microsoft. It enables you to create agents that can collaborate, use tools, and maintain complex workflows. Key features include: - Multi-Agent Systems: Build collaborative agent workflows - MCP Workbench: Native support for Model Context Protocol tools - Streaming HTTP: Connect to external services through streamable HTTP - AssistantAgent: Pre-built agent class for tool-using assistants ## What is the Optimoroute MCP server, and what's possible with it? The Optimoroute MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Optimoroute account. It provides structured and secure access to your logistics and planning data, so your agent can perform actions like retrieving driver details, viewing planned delivery routes, checking route assignments, and monitoring driver status on your behalf. - Live driver roster and status retrieval: Instantly fetch up-to-date information about all drivers, including their current availability and contact details. - Planned route overview for any date: Have your agent pull a detailed list of all planned routes for a specific date, including stop information and route parameters. - Monitor unassigned orders and route gaps: Easily identify orders that haven’t been assigned to a route, helping you spot scheduling bottlenecks. - Centralized route and driver reporting: Aggregate route and driver data to power dashboards or daily logistics summaries, all via your AI agent. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `OPTIMOROUTE_CREATE_ORDER` | Create Order | Tool to create a new order or update an existing order in OptimoRoute. Use when you need to add delivery, pickup, or task orders to the system with location, time windows, and other constraints. | | `OPTIMOROUTE_CREATE_OR_UPDATE_ORDERS` | Create or Update Orders | Tool to bulk create, update, or replace multiple orders at once without geocoding. Use when you need to add new orders or modify existing ones efficiently. Supports up to 500 orders per request. | | `OPTIMOROUTE_DELETE_ALL_ORDERS` | Delete All Orders | Tool to remove all orders and planned routes for a specified date. Use when you need to clear orders for a specific date or delete all orders system-wide if no date is provided. | | `OPTIMOROUTE_DELETE_ORDER` | Delete Order | Tool to remove a single order from the OptimoRoute system. Use when you need to delete a specific order by its orderNo. | | `OPTIMOROUTE_DELETE_ORDERS` | Delete Orders | Tool to delete one or more orders from the system in bulk (max 500 per request). Use when you need to remove orders, either individually or in batch operations. | | `OPTIMOROUTE_GET_COMPLETION_DETAILS` | Get Order Completion Details | Tool to retrieve completion details for one or more orders including proof of delivery data. Use when you need to check order completion status, timing details, and form data. | | `OPTIMOROUTE_GET_DRIVERS` | Get Drivers | Tool to retrieve all drivers in the system. Use when you need up-to-date driver data including status and contact information. | | `OPTIMOROUTE_GET_EVENTS` | Get Mobile Events | Tool to retrieve mobile events from drivers' field operations. Use when you need to track order completions, status changes (success, failed, on_duty, off_duty), and other field events for the currently active plan. | | `OPTIMOROUTE_GET_ORDERS` | Get Orders | Tool to retrieve one or more orders from OptimoRoute. Use when you need detailed order information including location, time windows, and assignment details. | | `OPTIMOROUTE_GET_PLANNING_STATUS` | Get Planning Status | Tool to retrieve the status of an active planning/optimization process. Use when you need to check the progress of a planning job by providing its ID. | | `OPTIMOROUTE_GET_ROUTES` | Get Planned Routes | Tool to retrieve all planned routes for a given date. Use when you need a detailed view of routes including optional stops, route parameters, and unassigned orders. | | `OPTIMOROUTE_GET_SCHEDULING_INFO` | Get Order Scheduling Info | Tool to retrieve scheduling information for a specific order. Use when you need to check if an order is scheduled and get details like driver assignment, timing, and position. | | `OPTIMOROUTE_SEARCH_ORDERS` | Search Orders | Tool to search for orders in OptimoRoute based on criteria. Use when you need to find orders by date range, order identifiers, or order status. At least one of 'orders' or 'date_range' must be provided. | | `OPTIMOROUTE_START_PLANNING` | Start Planning | Tool to start the planning/optimization process for a specified date or date range. Use when you need to generate optimized routes for orders and drivers. Requires orders to be created before planning can begin. | | `OPTIMOROUTE_STOP_PLANNING` | Stop Planning | Tool to stop an active planning/optimization process. Use when you need to halt a running planning job by providing its ID. | | `OPTIMOROUTE_UPDATE_DRIVER_PARAMETERS` | Update Driver Parameters | Tool to update driver parameters for a specific date including work times, vehicle assignment, and start/end locations. Use when you need to modify driver availability or routing constraints. Note that this unschedules existing routes for the driver on the specified date. | | `OPTIMOROUTE_UPDATE_DRIVERS_PARAMETERS` | Update Drivers Parameters | Tool to update parameters of multiple drivers for specified dates in bulk (max 500 per request). Use when you need to modify driver configuration including work hours, vehicle assignments, and location settings. Note: Existing routes for the specified drivers and dates will be unscheduled. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Optimoroute MCP server is an implementation of the Model Context Protocol that connects your AI agents and assistants directly to Optimoroute. Instead of manually wiring Optimoroute APIs, OAuth, and scopes yourself, you get a structured, tool-based interface that an LLM can call safely. With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster. ## Step-by-step Guide ### 1. Prerequisites You will need: - A Composio API key - An OpenAI API key (used by Autogen's OpenAIChatCompletionClient) - A Optimoroute account you can connect to Composio - Some basic familiarity with Autogen and Python async ### 1. Getting API Keys for OpenAI and Composio OpenAI API Key - Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) 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 - Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Navigate to your API settings and generate a new API key. - Store this key securely as you'll need it for authentication. ### 2. Install dependencies Install Composio, Autogen extensions, and dotenv. What's happening: - composio connects your agent to Optimoroute via MCP - autogen-agentchat provides the AssistantAgent class - autogen-ext-openai provides the OpenAI model client - autogen-ext-tools provides MCP workbench support ```bash pip install composio python-dotenv pip install autogen-agentchat autogen-ext-openai autogen-ext-tools ``` ### 3. Set up environment variables Create a .env file in your project folder. What's happening: - COMPOSIO_API_KEY is required to talk to Composio - OPENAI_API_KEY is used by Autogen's OpenAI client - USER_ID is how Composio identifies which user's Optimoroute connections to use ```bash COMPOSIO_API_KEY=your-composio-api-key OPENAI_API_KEY=your-openai-api-key USER_ID=your-user-identifier@example.com ``` ### 4. Import dependencies and create Tool Router session What's happening: - load_dotenv() reads your .env file - Composio(api_key=...) initializes the SDK - create(...) creates a Tool Router session that exposes Optimoroute tools - session.mcp.url is the MCP endpoint that Autogen will connect to ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Optimoroute session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["optimoroute"] ) url = session.mcp.url ``` ### 5. Configure MCP parameters for Autogen Autogen expects parameters describing how to talk to the MCP server. That is what StreamableHttpServerParams is for. What's happening: - url points to the Tool Router MCP endpoint from Composio - timeout is the HTTP timeout for requests - sse_read_timeout controls how long to wait when streaming responses - terminate_on_close=True cleans up the MCP server process when the workbench is closed ```python # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) ``` ### 6. Create the model client and agent What's happening: - OpenAIChatCompletionClient wraps the OpenAI model for Autogen - McpWorkbench connects the agent to the MCP tools - AssistantAgent is configured with the Optimoroute tools from the workbench ```python # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Optimoroute assistant agent with MCP tools agent = AssistantAgent( name="optimoroute_assistant", description="An AI assistant that helps with Optimoroute operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) ``` ### 7. Run the interactive chat loop What's happening: - The script prompts you in a loop with You: - Autogen passes your input to the model, which decides which Optimoroute tools to call via MCP - agent.run_stream(...) yields streaming messages as the agent thinks and calls tools - Typing exit, quit, or bye ends the loop ```python print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Optimoroute related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ["exit", "quit", "bye"]: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, "content") and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") ``` ## Complete Code ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Optimoroute session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["optimoroute"] ) url = session.mcp.url # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Optimoroute assistant agent with MCP tools agent = AssistantAgent( name="optimoroute_assistant", description="An AI assistant that helps with Optimoroute operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Optimoroute related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ['exit', 'quit', 'bye']: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, 'content') and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") if __name__ == "__main__": asyncio.run(main()) ``` ## Conclusion You now have an Autogen assistant wired into Optimoroute through Composio's Tool Router and MCP. From here you can: - Add more toolkits to the toolkits list, for example notion or hubspot - Refine the agent description to point it at specific workflows - Wrap this script behind a UI, Slack bot, or internal tool Once the pattern is clear for Optimoroute, you can reuse the same structure for other MCP-enabled apps with minimal code changes. ## How to build Optimoroute MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/optimoroute/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/optimoroute/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/optimoroute/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/optimoroute/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/optimoroute/framework/codex) - [OpenClaw](https://composio.dev/toolkits/optimoroute/framework/openclaw) - [Hermes](https://composio.dev/toolkits/optimoroute/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/optimoroute/framework/cli) - [Google ADK](https://composio.dev/toolkits/optimoroute/framework/google-adk) - [LangChain](https://composio.dev/toolkits/optimoroute/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/optimoroute/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/optimoroute/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/optimoroute/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/optimoroute/framework/crew-ai) ## Related Toolkits - [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly. - [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place. - [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations. - [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals. - [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem. - [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity. - [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently. - [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place. - [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time. - [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time. - [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place. - [Ascora](https://composio.dev/toolkits/ascora) - Ascora is a cloud-based field service management platform for service businesses. It streamlines scheduling, invoicing, and customer operations in one place. - [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place. - [Beeminder](https://composio.dev/toolkits/beeminder) - Beeminder is an online goal-tracking platform that uses monetary pledges to keep you motivated. Stay accountable and hit your targets with real financial incentives. - [Boxhero](https://composio.dev/toolkits/boxhero) - Boxhero is a cloud-based inventory management platform for SMBs, offering real-time updates, barcode scanning, and team collaboration. It helps businesses streamline stock tracking and analytics for smarter inventory decisions. - [Breathe HR](https://composio.dev/toolkits/breathehr) - Breathe HR is cloud-based HR software for SMEs to manage employee data, absences, and performance. It simplifies HR admin, making it easy to keep employee records accurate and up to date. - [Breeze](https://composio.dev/toolkits/breeze) - Breeze is a project management platform designed to help teams plan, track, and collaborate on projects. It streamlines workflows and keeps everyone on the same page. - [Bugherd](https://composio.dev/toolkits/bugherd) - Bugherd is a visual feedback and bug tracking tool for websites. It helps teams and clients report website issues directly on live sites for faster fixes. - [Canny](https://composio.dev/toolkits/canny) - Canny is a platform for managing customer feedback and feature requests. It helps teams prioritize product decisions based on real user insights. - [Chmeetings](https://composio.dev/toolkits/chmeetings) - Chmeetings is a church management platform for events, members, donations, and volunteers. It streamlines church operations and improves community engagement. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Optimoroute MCP? With a standalone Optimoroute MCP server, the agents and LLMs can only access a fixed set of Optimoroute tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Optimoroute and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Autogen? Yes, you can. Autogen 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 Optimoroute tools. ### Can I manage the permissions and scopes for Optimoroute while using Tool Router? Yes, absolutely. You can configure which Optimoroute 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 Optimoroute data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)