Skip to main content
Glama

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. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations only declare destructiveHint=true; the description goes further by naming exactly what is destroyed (existing routes for that date are REPLACED under the default) and by disclosing the asynchronous contract (returns a planningId that must be polled). It does not mention permission/plan-gating beyond 'if the plan allows', which is a minor gap for a mutation tool.

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?

Three dense sentences with zero filler, front-loaded with the destructive default before the alternative and the lifecycle. Every clause carries operational information.

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

Completeness4/5

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

For a 14-parameter async mutation with no output schema, the description covers the essential missing pieces: the return value (planningId), the polling path, and the cancellation path. It does not explain the async failure/timeout behavior, but the core call-correctness information is present.

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 coverage is 100%, so baseline is 3, but the description adds meaningful cross-parameter semantics: the startWith/lockType interaction and the destructive consequence of the EMPTY default, which the schema documents only as isolated enum values. It leaves the other twelve parameters to the schema, which is acceptable given full coverage.

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 precise verb+resource ('Start OptimoRoute's route optimization') with the scope ('for a date (or a dateRange for weekly planning, if the plan allows)'). It is immediately distinguishable from siblings like optimoroute_stop_planning and optimoroute_get_planning_status, which it names directly.

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?

Gives explicit when/when-not guidance: default startWith EMPTY replaces existing routes, while startWith CURRENT (+ lockType) keeps them. It also names the follow-up alternatives (get_planning_status to poll, get_routes to read, stop_planning to cancel), so the agent knows the full operational sequence.

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.