Skip to main content
Glama

optimoroute

Start route planning

optimoroute_start_planning
Destructive

Start OptimoRoute's route optimization for a date (or a dateRange for weekly planning, if the plan allows). With the default startWith EMPTY, existing routes for that date are REPLACED; use startWith CURRENT (+ lockType) to keep them. Returns a planningId — poll it with optimoroute_get_planning_status, then read the result with optimoroute_get_routes. Can be cancelled with optimoroute_stop_planning. OptimoRoute: POST /start_planning.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateNoDate to plan, YYYY-MM-DD. Ignored if dateRange is set.
lockTypeNoWith CURRENT: NONE allow changes; ROUTES keep planned routes; RESOURCES keep driver per order.
balanceByNoBalance by WT working time or NUM order count.
balancingNoOFF best routes; ON balance workload; ON_FORCE balance and use every driver.
dateRangeNoPlan several days at once (weekly planning).
startWithNoEMPTY (default) plans from scratch; CURRENT starts from existing routes.
clusteringNoMinimize overlap between drivers' routes.
depotTripsNoLet drivers return to the depot to reload.
useDriversNoOnly plan with these drivers. Default: all available drivers.
balancingFactorNo0.0-1.0, how much balancing outweighs route cost (ON_FORCE only).
useOrderObjectsNoOnly plan these orders. Default: all valid orders on the date.
depotVisitDurationNoMinutes spent at a depot visit.
midRouteDepotVisitsNoAllow mid-route depot visits (needs Dynamic Mid-Route Depots on the account).
includeScheduledOrdersNoWhen planning a subset, keep other orders already scheduled on those drivers (default true).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only carry destructiveHint=true; the description supplies the operative detail the annotation cannot - exactly what is destroyed (existing routes for the date) and the parameter combination that prevents it. It also discloses the async contract (returns a planningId to poll) and the cancellation path, which is behavior an agent needs before invoking.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Five tight sentences, each carrying distinct load: scope, destructive default and its mitigation, async return contract, lifecycle routing, and the API endpoint. The highest-stakes constraint (replacement of routes) is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 14-parameter, nested-object, no-output-schema tool, the description covers the points an agent cannot infer: destructive default, preservation path, async polling flow, and downstream/cleanup tools. Remaining parameter nuance is fully documented in the schema, so nothing critical is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3, but the description adds cross-parameter semantics the schema does not: the interaction between startWith and lockType (CURRENT + lockType to preserve routes). That is genuinely more than the per-field schema text, though it covers only a subset of the 14 parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Start OptimoRoute's route optimization for a date') with the exact scope (single date vs dateRange for weekly planning). Clearly distinguishable from siblings like get_planning_status, get_routes, and stop_planning, which it names as part of the lifecycle.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly tells the agent when the destructive default applies ('startWith EMPTY, existing routes for that date are REPLACED') and how to avoid it ('use startWith CURRENT (+ lockType) to keep them'). It also routes the agent through the full workflow: poll with get_planning_status, read with get_routes, cancel with stop_planning.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.