Skip to main content
Glama

optimoroute

Create or update an order

optimoroute_create_order
Destructive

Create one order, or update an existing one, with address geocoding. operation: CREATE (new; errors if orderNo exists), UPDATE (existing only), MERGE (create or update only the fields you send — safest for edits), SYNC (create or REPLACE all fields with what you send). CREATE/SYNC/MERGE of a new order need date, type, location and orderNo or id. A location is either an existing locationNo alone, an address to geocode, or latitude+longitude+locationName. OptimoRoute: POST /create_order.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoOptimoRoute's order id. Takes priority over orderNo when matching.
dateNoOrder date, YYYY-MM-DD.
typeNoD = delivery, P = pickup, T = task.
emailNoCustomer email for notifications.
load1NoLoad units #1 (boxes, kg, ...) per your capacity setup.
load2NoLoad units #2.
load3NoLoad units #3.
load4NoLoad units #4.
notesNoNotes for the driver's instructions.
phoneNoCustomer phone number.
skillsNoRequired driver skill codes.
orderNoNoYour order number, shown in the web app. Used to match existing orders.
durationNoService time at the location, in minutes.
locationNoWhere the order is serviced.
priorityNoL low, M medium (default), H high, C critical.
operationYesHow to apply the order (see description).
relatedIdNoid of a related pickup/delivery.
assignedToNoForce the order onto one driver, e.g. {"serial": "102"} or {"externalId": "444"}. null clears it.
timeWindowsNoWhen the order can be serviced, e.g. [{"twFrom": "10:00", "twTo": "14:00"}].
allowedDatesNoRestrict the dates the order may be scheduled, e.g. {"from": "2026-10-01", "to": "2026-10-07"}.
customField1NoLegacy custom field #1.
customField2NoLegacy custom field #2.
customField3NoLegacy custom field #3.
customField4NoLegacy custom field #4.
customField5NoLegacy custom field #5.
customFieldsNoNew-style custom fields keyed by the field key configured in OptimoRoute.
relatedOrderNoNoorderNo of a related pickup/delivery (set on the second order of the pair).
allowedWeekdaysNoWeekdays the order may be scheduled on. Default: all.
vehicleFeaturesNoRequired vehicle feature codes.
allowedDateTimesNoDatetime windows in which the service may begin.
acceptDuplicateOrderNoNoAllow CREATE of an order whose orderNo already exists.
notificationPreferenceNoHow order-tracking notifications are delivered for this order.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.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 adds real behavioral content — CREATE errors on an existing orderNo, SYNC replaces all fields, MERGE touches only sent fields, geocoding is attempted for addresses, and location can be an existing locationNo or coordinates. It does not mention idempotency, rate limits, or auth requirements, but it is consistent with (not contradicting) the destructive hint.

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

Conciseness4/5

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

Front-loaded with the operation-mode semantics, which is the highest-value information, and each sentence addresses a decision the caller must make. It is dense but not padded; only the endpoint note ('POST /create_order') feels like filler.

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

Completeness3/5

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

For a 32-parameter mutation tool with only destructiveHint=true as annotation coverage and no output schema, the description covers mode semantics and required fields well. It omits when to prefer the bulk sibling, error/partial-failure behavior beyond duplicates, and return shape, leaving gaps an agent may hit on first use.

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

Parameters3/5

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

Schema description coverage is 100% across 32 parameters, so the schema already carries the per-field semantics (including the locationNo-only rule that the description restates). The description adds only the cross-cutting required-field rule for CREATE/SYNC/MERGE of a new order, which is a modest increment over the structured fields.

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

Purpose4/5

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

States a specific verb and resource ('Create one order, or update an existing one, with address geocoding') and enumerates the four operation modes, which is genuinely informative. However it never distinguishes this tool from its obvious sibling optimoroute_create_or_update_orders (plural/bulk), so an agent cannot tell the two apart from the description alone.

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

Usage Guidelines3/5

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

It gives in-tool guidance on which operation to pick ('UPDATE (existing only)', 'MERGE — safest for edits', 'SYNC (create or REPLACE all fields)') and states required fields per mode, which is useful. It offers no guidance on when to reach for this tool versus the plural sibling or the read/planning siblings, so the alternative-selection gap is unaddressed.

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.