Maps for agents: truck/ADR routing, geocoding, places, matrices, isochrones, EV and fleet planning.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Road incidents a TRAFFIC CAMERA SAW and a vision model CONFIRMED, in force now: near a point (`near` [lat, lon] with `radius_m`, default 1000, at most 10000), in a `bbox` [min_lon, min_lat, max_lon, max_lat], or along a route `shape` (polyline6 from `route`, corridor `buffer_m` default 60). Give exactly one. Each record says what it asserts (`closed` or a `speed_override` in km/h) on which OSM ways and carriageway, what was seen (collision, stalled vehicle, wrong-way vehicle), the camera, the clip URL the verdict was made on (`evidence_url`), the verifier and its `confidence`, and when it lifts (`end`, always within minutes: these records expire on their own). Camera records RANK BELOW official closures and never retract one. READ `coverage_note` ALOUD: an empty list means no camera-verified incident here, NEVER a clear road. Show `attribution` verbatim (Powered by TfL Open Data). Off unless the deployment arms camera incidents (SN_CAMERA_INCIDENTS_ENABLED): an unarmed gateway answers 501 and says so. Requires the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY).
`[min_lon, min_lat, max_lon, max_lat]`.
`[lat, lon]` plus `radius_m` (default 1000).
A route shape as polyline6; the corridor rule of `/v1/incidents/along` applies (`buffer_m` default 60).
Corridor half-width for `shape`, metres.
Radius for `near`, metres, at most 10000.
Drop records below this confidence (default 0).
Include records that have expired in the last hour, for the operator's timeline (default false).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Road incidents a TRAFFIC CAMERA SAW and a vision model CONFIRMED, in force now: near a point (`near` [lat, lon] with `radius_m`, default 1000, at most 10000), in a `bbox` [min_lon, min_lat, max_lon, max_lat], or along a route `shape` (polyline6 from `route`, corridor `buffer_m` default 60). Give exactly one. Each record says what it asserts (`closed` or a `speed_override` in km/h) on which OSM ways and carriageway, what was seen (collision, stalled vehicle, wrong-way vehicle), the camera, the clip URL the verdict was made on (`evidence_url`), the verifier and its `confidence`, and when it lifts (`end`, always within minutes: these records expire on their own). Camera records RANK BELOW official closures and never retract one. READ `coverage_note` ALOUD: an empty list means no camera-verified incident here, NEVER a clear road. Show `attribution` verbatim (Powered by TfL Open Data). Off unless the deployment arms camera incidents (SN_CAMERA_INCIDENTS_ENABLED): an unarmed gateway answers 501 and says so. Requires the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY).
| Argument | Type | Description |
|---|---|---|
| bbox | array | null | `[min_lon, min_lat, max_lon, max_lat]`. |
| near | array | null | `[lat, lon]` plus `radius_m` (default 1000). |
| shape | string | null | A route shape as polyline6; the corridor rule of `/v1/incidents/along` applies (`buffer_m` default 60). |
| buffer_m | number | null | Corridor half-width for `shape`, metres. |
| radius_m | number | null | Radius for `near`, metres, at most 10000. |
| min_confidence | number | null | Drop records below this confidence (default 0). |
| include_recently_expired | boolean | Include records that have expired in the last hour, for the operator's timeline (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"bbox": {
"type": [
"array",
"null"
],
"items": {
"type": "number",
"format": "double"
},
"maxItems": 4,
"minItems": 4,
"description": "`[min_lon, min_lat, max_lon, max_lat]`."
},
"near": {
"type": [
"array",
"null"
],
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "`[lat, lon]` plus `radius_m` (default 1000)."
},
"shape": {
"type": [
"string",
"null"
],
"description": "A route shape as polyline6; the corridor rule of\n`/v1/incidents/along` applies (`buffer_m` default 60)."
},
"buffer_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Corridor half-width for `shape`, metres."
},
"radius_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Radius for `near`, metres, at most 10000."
},
"min_confidence": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Drop records below this confidence (default 0)."
},
"include_recently_expired": {
"type": "boolean",
"default": false,
"description": "Include records that have expired in the last hour, for the\noperator's timeline (default false)."
}
}
}Find the best EV charge points along a route, with the REAL extra travel time of stopping at each one, never a straight-line guess. Provide `origin` + `destination` (a route is computed) or an existing route's `geometry_polyline6`, plus optional `connectors` ("ccs", "type2", "chademo", "type1", "tesla", "domestic", "other"), `min_kw` (e.g. 50 for rapid only), `available_only` and `max_detour_minutes` (default 10). Charge points come from operator-published feeds, are costed through the routing engine with your costing (a `truck` profile makes detours respect dimensional/ADR restrictions) and ranked most powerful first, since minutes off the clock are bought with kilowatts. Each result carries max_power_kw, connector_standards, best_connector, evse_count, detour_minutes/detour_km and, where a live feed backs it, available_now. IMPORTANT: there is no national charge-point registry, every deployment covers only the operators it has onboarded, so ALWAYS show the returned `coverage_note` alongside the results. An empty `results` means "none from these operators within the detour budget", NEVER "there are no chargers here". Statuses are live only when availability_live is true; otherwise they are the values captured at the last ingest and must not be described as current. `say` is ALWAYS present and is the whole answer as one short spoken line, composed by the gateway with the coverage already inside the claim rather than appended to it: it scopes its superlative to the operators this deployment holds, and an empty result's line says the emptiness is about those operators. Prefer reading it verbatim to writing your own summary. Requires the MapMap gateway; answers a clear error when the deployment has no charge-point dataset. Display the returned charging_attribution with the results.
| Argument | Type | Description |
|---|---|---|
| truck | any | Truck profile (dimensions + ADR declaration). Requires costing "truck"; the detours then respect dimensional/ADR restrictions. |
| min_kw | number | null | Keep only charge points whose best connector is rated at least this many kW (e.g. 50 for rapid charging only). |
Find the cheapest fuel along a route, with the REAL extra travel time of stopping at each station, never a straight-line guess. Provide `origin` + `destination` (a route is computed) or an existing route's `geometry_polyline6`, plus a `fuel` code ("diesel" default, "petrol_95", "petrol_98", "premium_diesel", "e85", "lpg") and `max_detour_minutes` (default 10). Stations come from the live open-data price feeds (UK CMA retailer scheme and/or the statutory Fuel Finder, FR prix-carburants, DE Tankerkoenig; the response's `fuel_attribution` names the ones actually matched), are priced through the routing engine with your costing (a `truck` profile makes detours respect dimensional/ADR restrictions) and ranked freshest-priced first and cheapest within that. Each result carries price {value, currency, updated_at, stale}, detour_minutes/detour_km, and saving_per_litre vs the cheapest on-route baseline (pass `fill_litres` to also get saving_total). `stale` = not verifiably fresher than 24 h: true unless BOTH the price's own updated_at and the snapshot's fetch time are inside that window, and true whenever either is missing. A stale price is ranked below every fresh one, is never the baseline, and carries NO saving_per_litre, quote it as "last seen at X on <date>", never as a saving. `say` is ALWAYS present and is the whole answer as one short spoken line, composed by the gateway with the number, the detour and the honest qualifier already in it. Prefer reading it verbatim to writing your own summary: a stale price's line states the figure and the day it was last seen and claims no saving, and an empty result's line names the cause rather than implying there is no fuel on that road. Requires the MapMap gateway; answers a clear error when the deployment has no fuel-price dataset. Display the returned fuel_attribution with the prices.
| Argument | Type | Description |
|---|---|---|
| fuel | string | null | Which fuel to price: "diesel" (default), "petrol_95", "petrol_98", "premium_diesel", "e85" or "lpg" (aliases "petrol", "unleaded", "e10", "super_unleaded", "e5", "b7" and "sdv" are accepted). |
| truck | any |
Check whether a vehicle may pass through a tunnel of a given ADR category ("A"–"E"). Provide `hazmat` and, when known, the load's ADR 8.6.4 tunnel restriction code (e.g. "B", "C5000D", "B/D", "none"). Applies the conservative worst-case reading: conditional clauses are assumed to apply, so a blocked answer may over-restrict but never under-restricts. No network access; answers instantly.
| Argument | Type | Description |
|---|---|---|
| hazmat* | boolean | Whether the vehicle carries dangerous goods at all. When false the ADR tunnel matrix does not apply and every tunnel is permitted. |
| tunnel_code | string | null | ADR 8.6.4 tunnel restriction code of the load, e.g. "B", "C5000D", "B/D", or "(-)"/"none". Leave unset for a hazmat load of unknown code (conservatively treated as code B). |
| tunnel_category* | string | ADR category of the tunnel to check: "A", "B", "C", "D" or "E". |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"hazmat",
"tunnel_category"
],
"properties": {
"hazmat": {
"type": "boolean",
"description": "Whether the vehicle carries dangerous goods at all. When false the\nADR tunnel matrix does not apply and every tunnel is permitted."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\". Leave unset for a hazmat load of unknown\ncode (conservatively treated as code B)."
},
"tunnel_category": {
"type": "string",
"description": "ADR category of the tunnel to check: \"A\", \"B\", \"C\", \"D\" or \"E\"."
}
}
}Measure a vehicle's overhead clearance along a route against surveyed point cloud geometry, wherever survey coverage exists. Routes with truck costing (so the search already avoids the height restrictions the map has tagged), then measures that corridor. Give `origin`, `destination` and `height_m`; optional `width_m` asks the corridor-width axis too, and optional `margin_m` adds your operating margin to the vehicle before the verdict. Returns `pass`, `fail`, `indeterminate` or `no_verdict` with the limiting point, the measured headroom, its uncertainty bound (`safe_headroom_m`, `sigma_m`, `sampling_gap_m`) and a link to that exact view in the survey viewer. An `indeterminate` carries `indeterminate_reasons` as codes to branch on and the same reasons as English inside `explanation`; read out the English. A `pass` may carry no limiting point at all, which means the survey found nothing above that corridor, and the width axis may answer `not_assessed` where the corridor edges are too sparsely surveyed while the height axis still answers. Honesty, and it matters here: this measures physical geometry from a dated survey. It is not a signed or posted height, `clearance_enforcement.route_certified` is always false, and the caveat is on every answer including the clear one. Ground the survey did not cover comes back as `not_surveyed_m` and is never judged, so a `pass` is possible over complete coverage and nowhere else; sparse or stale coverage comes back separately as `insufficient_data_m`. Reach for this when a truck route came back unchanged and you need to know whether that means anything: an unchanged route avoids what the map records, which is a different claim from measured headroom, because a structure nobody tagged is routed through like open road. Needs the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY), which holds the surveys; there is no fallback, and it will not answer from the routing step alone. The mapmap://guide/clearance resource sets out what each answer proves.
| Argument | Type | Description |
|---|---|---|
| origin* | any | Route origin. |
| width_m |
Audit a map style's colour contrast against WCAG 2.1 (4.5:1 for label text, 3:1 for graphics like the route line), across both the light and dark palette variants. Pass a hosted `style_id` OR an inline `theme` document (as accepted by create_style). Advisory: failing pairs list the palette slots to adjust with set_palette; publishing is never blocked on contrast.
| Argument | Type | Description |
|---|---|---|
| theme | any | …or an inline theme document (as accepted by `create_style`). Exactly one of `style_id`/`theme` must be given. |
| style_id | string | null | Hosted style id whose latest theme should be checked… |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"theme": {
"description": "…or an inline theme document (as accepted by `create_style`).\nExactly one of `style_id`/`theme` must be given."
},
"style_id": {
"type": [
"string",
"null"
],
"description": "Hosted style id whose latest theme should be checked…"
}
}
}Group stops into balanced geographic clusters, so a day too large for one optimisation can be optimised one cluster at a time. This is the front half of the recipe for a thousand-stop day: cluster here, then call `optimise_routes` per cluster, where the routing engine's own matrix decides the visiting order. IMPORTANT, this is STRAIGHT-LINE clustering. Distances are measured between coordinates, not along the road network: no road, river, motorway junction or one-way system is consulted, and two stops either side of an estuary look adjacent. That makes it the right tool for deciding which stops belong TOGETHER and the wrong one for deciding what ORDER to visit them in. The answer carries a `basis` sentence saying exactly this; show it, so a centroid is never read as a plan. Provide `locations` ([{id, lat, lon, load?}], ids unique, at most 5,000) and EXACTLY ONE of `clusters` (how many groups, balanced by stop count), `max_cluster_locations` or `max_cluster_load` (a per-cluster ceiling the count is derived from). Optional `territories` keep a cluster from straddling a round: each is clustered on its own, and so are the stops inside none of them. Optional `seed` (default 42) drives the seeding, the same request with the same seed always returns the same clusters, on every deployment, so a re-run is a re-run. Returns each cluster's member ids, count, summed load, centroid and territory, plus a `balance` block naming the constraint applied and whether it had to be relaxed to place every stop: a load ceiling with lumpy loads is a bin-packing problem and may have no solution at the derived count. Requires the MapMap gateway.
| Argument | Type | Description |
|---|---|---|
| seed | integer | null | Seed for the k-means++ seeding (default 42). The same request with the same seed always returns the same clusters, on every deployment. |
| clusters | integer | null | How many clusters to produce, balanced by stop count. Give exactly one of `clusters`, `max_cluster_locations` or `max_cluster_load`. |
| locations |
Create a hosted map style. Provide a name, optionally a named `base` to start from (light, dark, streets, midnight, navigator-day, navigator-night, fleet, outdoor, dataviz, backdrop, print - call list_style_layers for what each one is for), and optionally a theme document ({base: "light"|"dark", palette: {slot: colour}, layers: {layer_id: overrides}}). The named base is laid down first and the theme document is merged over it, so "streets with darker water" is one call; with neither, the style starts from the default theme. A theme may also set worldview (ISO 3166-1 alpha-2, accepted: AE, KR, SA, US) to display that jurisdiction's official names for a small curated registry of renamed features; omitted, labels keep the OSM on-the-ground names. Returns the generated style_id (pass it to set_palette / set_layer_paint) and the compiled style URL for MapLibre.
| Argument | Type | Description |
|---|---|---|
| base | string | null | Optional named base to start from, e.g. "streets", "midnight", "navigator-night", "fleet". Call `list_style_layers` for the catalogue, including which bases expect an overlay of their own. The base's whole document is laid down first and `theme` is merged over it, so a base plus two palette entries is a complete style. Omitted, the style starts from the default light theme as it always did. |
| name* | string | Human-readable style name; its kebab-case slug seeds the style id. |
| theme | any | Optional theme document (palette/layer overrides). Merged over `base` when one is given; on its own, it replaces the default theme outright. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"base": {
"type": [
"string",
"null"
],
"description": "Optional named base to start from, e.g. \"streets\", \"midnight\",\n\"navigator-night\", \"fleet\". Call `list_style_layers` for the\ncatalogue, including which bases expect an overlay of their own. The\nbase's whole document is laid down first and `theme` is merged over\nit, so a base plus two palette entries is a complete style. Omitted,\nthe style starts from the default light theme as it always did."
},
"name": {
"type": "string",
"description": "Human-readable style name; its kebab-case slug seeds the style id."
},
"theme": {
"description": "Optional theme document (palette/layer overrides). Merged over\n`base` when one is given; on its own, it replaces the default theme\noutright."
}
}
}Sample terrain elevation. Provide `points` (a bare list of coordinates) for point elevation, or `encoded_polyline` (optionally with `resample_distance_m`) for an along-route profile, not both. Returns one sample per point/resampled point in order; `elevation_m` is null wherever the engine's DEM tile set has no coverage at that point (never a guess). The `encoded_polyline` form also returns each sample's resampled lat/lon and cumulative `range_km` from the start.
| Argument | Type | Description |
|---|---|---|
| points | array | null | Points to sample. Provide this or `encoded_polyline`, not both. |
| encoded_polyline | string | null | A route as a Google encoded polyline with six digits of precision. Provide this or `points`, not both. |
| resample_distance_m | number | null | Resamples `encoded_polyline` at this spacing in metres before sampling height (ignored for `points`). |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"points": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "Points to sample. Provide this or `encoded_polyline`, not both."
},
"encoded_polyline": {
"type": [
"string",
"null"
],
"description": "A route as a Google encoded polyline with six digits of precision.\nProvide this or `points`, not both."
},
"resample_distance_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Resamples `encoded_polyline` at this spacing in metres before\nsampling height (ignored for `points`)."
}
}
}Earthquakes, volcano alerts and satellite fire detections in a bounding box, for display. Pass `bbox` [west, south, east, north] (WGS84), optional `types` (quake, volcano, fire; default all), `min_magnitude` (quakes, default 2.5) and `limit` (1 to 500, default 100). Earthquakes are USGS, magnitude 2.5 and above, past 24 hours, as reported (magnitudes and locations may be revised). Volcano alerts are USGS-monitored volcanoes ONLY: an absent alert says nothing about volcanoes elsewhere. Fire cells are NASA FIRMS VIIRS detections thinned to 0.5 degree cells: satellite-detected heat, NOT confirmed fires. Each feed carries `status` (ok, stale, unknown): pass a stale or unknown status on, never present old data as current. This is reported data for display, not a warning service and not safety-critical; keep that qualifier when you pass it on. Requires the MapMap gateway. Display the returned `attribution`, and for fire data the FIRMS `acknowledgment` and `disclaimer`.
| Argument | Type | Description |
|---|---|---|
| bbox* | array | Bounding box `[west, south, east, north]`, WGS84 degrees. West must be less than east and south less than north; a box crossing the antimeridian is not supported (query two boxes). |
| limit | integer | null | Most events to return, 1 to 500 (default 100). Newest quakes first, then volcano alerts, then the busiest fire cells. |
| types | array | null | Which feeds to include: any of `quake`, `volcano`, `fire`. Default: all three. |
| min_magnitude | number | null | Smallest earthquake magnitude, 2.5 to 9.0 (default 2.5). Quakes only. |
Area in square metres enclosed by a ring of 3+ coordinates, computed geodesically. Always positive: the answer does not depend on whether the ring is wound clockwise or anticlockwise. Intended for zones and boundaries, not for polygons covering more than half the globe. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| points* | array | The coordinates to consider. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"points"
],
"properties": {
"points": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The coordinates to consider."
}
}
}The axis-aligned bounding box enclosing 1+ coordinates, as {min_lat, min_lon, max_lat, max_lon}. Useful for fitting a map view to a set of stops. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| points* | array | The coordinates to consider. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"points"
],
"properties": {
"points": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The coordinates to consider."
}
}
}Initial bearing from one coordinate to another, in degrees clockwise from true north (0-360). This is the bearing at the START of the geodesic; over long distances the bearing changes en route. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| to* | any | End coordinate. |
| from* | any | Start coordinate. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from",
"to"
],
"properties": {
"to": {
"$ref": "#/$defs/LatLon",
"description": "End coordinate."
},
"from": {
"$ref": "#/$defs/LatLon",
"description": "Start coordinate."
}
}
}The centroid (geometric mean position) of 1+ coordinates, e.g. to pick a depot location or centre a map. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| points* | array | The coordinates to consider. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"points"
],
"properties": {
"points": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The coordinates to consider."
}
}
}The coordinate reached by travelling `distance_m` metres from `from` on `bearing_deg` (degrees clockwise from true north). The inverse of `geo_distance` + `geo_bearing`. Local computation: no network call.
| Argument | Type | Description |
|---|---|---|
| from* | any | Starting coordinate. |
| distance_m* | number | Distance to travel in metres. |
| bearing_deg* | number | Bearing in degrees clockwise from true north. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from",
"bearing_deg",
"distance_m"
],
"properties": {
"from": {
"$ref": "#/$defs/LatLon",
"description": "Starting coordinate."
},
"distance_m": {
"type": "number",
"format": "double",
"description": "Distance to travel in metres."
},
"bearing_deg": {
"type": "number",
"format": "double",
"description": "Bearing in degrees clockwise from true north."
}
}
}Distance in metres between two coordinates. Computed geodesically on the WGS84 ellipsoid, so it is the straight-line (as-the-crow-flies) distance, NOT a driving distance, use `route` or `matrix` for travel distance and time. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| to* | any | End coordinate. |
| from* | any | Start coordinate. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from",
"to"
],
"properties": {
"to": {
"$ref": "#/$defs/LatLon",
"description": "End coordinate."
},
"from": {
"$ref": "#/$defs/LatLon",
"description": "Start coordinate."
}
}
}Total length in metres of a polyline through 2+ coordinates, summed geodesically. This measures the line you supply, NOT a driven route , use `route` for that. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| points* | array | The coordinates to consider. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"points"
],
"properties": {
"points": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The coordinates to consider."
}
}
}The closest position on a polyline to a given coordinate, plus the geodesic distance to it in metres. The answer may lie between vertices, not only on them. Useful for 'how far is this address from the route?'. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| line* | array | The polyline's coordinates, 2 or more. |
| point* | any | The coordinate to measure from. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"point",
"line"
],
"properties": {
"line": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The polyline's coordinates, 2 or more."
},
"point": {
"$ref": "#/$defs/LatLon",
"description": "The coordinate to measure from."
}
}
}Whether a coordinate lies inside a polygon: delivery zones, catchments, congestion or clean-air zones, site boundaries. Provide `point` {lat, lon} and `polygon` as 3+ {lat, lon} coordinates of the outer ring (closed automatically if the last does not repeat the first). Points exactly on the boundary count as OUTSIDE. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| point* | any | The coordinate to test. |
| polygon* | array | The polygon's outer ring, 3 or more coordinates. Closed automatically if the last point does not repeat the first. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"point",
"polygon"
],
"properties": {
"point": {
"$ref": "#/$defs/LatLon",
"description": "The coordinate to test."
},
"polygon": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The polygon's outer ring, 3 or more coordinates. Closed\nautomatically if the last point does not repeat the first."
}
}
}Reduce the number of coordinates in a polyline while keeping its shape (Douglas-Peucker). `tolerance_deg` is in DEGREES, not metres: about 0.0001 drops detail finer than roughly 10 m at the equator. Endpoints are always kept. Returns the retained points and how many were removed. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| points* | array | The polyline's coordinates, 2 or more. |
| tolerance_deg* | number | Douglas-Peucker tolerance in **degrees**, not metres. Around 0.0001 drops detail finer than roughly 10 m at the equator. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"points",
"tolerance_deg"
],
"properties": {
"points": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The polyline's coordinates, 2 or more."
},
"tolerance_deg": {
"type": "number",
"format": "double",
"description": "Douglas-Peucker tolerance in **degrees**, not metres. Around\n0.0001 drops detail finer than roughly 10 m at the equator."
}
}
}Turn a place (address, POI, town) into coordinates. Ask two ways, and they combine: `query` is free text, one run-together string, the way a person types into a search box, and `street`, `housenumber`, `city`, `postcode` and `country` name the parts of an address separately. At least one of the two is required. Pass the parts whenever you already hold the address in parts (a form, a CRM row, a manifest): components are REQUIREMENTS, not hints, so `city: "London"` means a result outside London cannot come back at all, where "London" inside `query` only reorders. `country` takes an ISO 3166-1 alpha-2 code or a country name ("GB", "United Kingdom"); a value naming no country is refused rather than silently matching nothing. Returns up to `limit` (default 10) candidates with name, one-line label, lat/lon, type and address parts. Pass `focus` {lat, lon} to rank results near a location higher. A bare city or town name (no comma) lists that city's airports and main railway stations directly behind it, ahead of namesakes elsewhere. Each hit also carries `match`: a per-component matched/inferred/unmatched verdict, the `score_gap` to the runner-up, and which backend answered. READ IT before acting on an address, an unmatched or inferred postcode on the top hit means the answer does not carry the address you asked for, and a small `score_gap` means the ranking barely chose, so show the alternatives instead of picking one. Use `verify_places` when the address came from a model or a user and needs checking rather than using. Results are matched in `lang` (default "en"), so English exonyms ("Munich", "Cologne", "Geneva") resolve to the place meant; pass `lang` when querying in another language, or "default" for each place's local name.
| Argument | Type | Description |
|---|---|---|
| city | string | null | Structured component: town or city, e.g. "London". Matches the containing city as well as the immediate locality, so a suburb name works here too. |
| lang | string | null | Language of the place names to match and return, as a two-letter code. Defaults to "en", which is what makes English exonyms ("Munich", "Cologne", "Geneva") resolve to the place meant rather than a same-named town elsewhere. Set it to the language your query is written in; "default" asks for each place's own local name. Deployments support a fixed set (this one: "en", "de", "fr"), and anything outside it is refused. |
Read an asynchronous job submitted with `submit_optimise_job`: its status, and once it has finished, its result inline, exactly the body the synchronous tool would have returned. Status is `queued`, `running`, `succeeded` or `failed`; the answer's `terminal` field says whether the job will ever leave the status it is in, so poll while that is false. POLLING IS FREE: the gateway meters the submission and not the reads, deliberately, because a poll that costs quota is a poll a caller rations, and a rationed poll is how a job that finished in ten seconds gets noticed four minutes later. Check every few seconds rather than guessing at a duration. `units_charged` is what the SUBMISSION drew, and `refunded` says whether a failure handed it back, a failed job shows both, because reporting zero would be a lie about what was charged. Webhooks are the alternative to polling and exist for humans wiring infrastructure, not for agents in a loop. A job belongs to the key that submitted it (or another key of the same identity); anyone else's id answers NOT FOUND rather than forbidden, because confirming an id exists is itself a disclosure. Requires the MapMap gateway.
| Argument | Type | Description |
|---|---|---|
| id* | string | The job id returned by `submit_optimise_job`. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The job id returned by `submit_optimise_job`."
}
}
}Fetch a hosted style's latest theme document (the editable source) and the URL of its latest compiled MapLibre style. Use the theme to inspect current palette and layer overrides before editing.
| Argument | Type | Description |
|---|---|---|
| style_id* | string | Hosted style id, e.g. "midnight-fleet-a1b2c3". |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"style_id"
],
"properties": {
"style_id": {
"type": "string",
"description": "Hosted style id, e.g. \"midnight-fleet-a1b2c3\"."
}
}
}Check what your own API key has spent, so you can decide mid-task whether to keep going. Reading it is free: it costs no quota. Optional `from` and `to` (YYYY-MM-DD UTC, inclusive, at most 92 days apart) bound the report; omitted, it covers the current month to date. Returns `days` (per-day, per-endpoint), `totals` per endpoint over the range, `total_units`, plus `month_used_units` against `monthly_quota_units` and the prepaid `balance_millipence` (thousandths of a penny). Everything is counted in UNITS, weighted quota units, where a heavier endpoint costs more than one unit per request, so never report these figures as a number of calls. When `identity_pooled` is true the quota is shared with the other keys belonging to the same owner, so these figures are not yours alone. The key that authenticates the call is the key reported on: there is no way to read another caller's usage. Needs the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY).
| Argument | Type | Description |
|---|---|---|
| to | string | null | Last day to report, `YYYY-MM-DD` (UTC) inclusive. Defaults to today. |
| from | string | null | First day to report, `YYYY-MM-DD` (UTC) inclusive. Defaults to the first day of the current month. At most 92 days may separate `from` and `to`. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"to": {
"type": [
"string",
"null"
],
"description": "Last day to report, `YYYY-MM-DD` (UTC) inclusive. Defaults to\ntoday."
},
"from": {
"type": [
"string",
"null"
],
"description": "First day to report, `YYYY-MM-DD` (UTC) inclusive. Defaults to the\nfirst day of the current month. At most 92 days may separate\n`from` and `to`."
}
}
}Three to five short spoken lines an hour about the ground a route is on: one sentence, at the point the driver reaches the thing it is about, and then silence. Not a tour and not a chatbot. NOTHING IS GENERATED HERE: every line is a sentence a person wrote from a public-domain plaque inscription and a person reviewed, compiled into the gateway binary, so no model runs in this path and the lines are identical for every driver. Give `geometry_polyline6` from the `route` tool and, IMPORTANT, `duration_s` from the same answer: without it the silence budget falls back to a distance, and "four lines an hour" is a claim about time that a distance answers wrongly at both ends. Optional `min_gap_s`, `min_gap_m`, `max_offset_m` (default 60, hard ceiling 80), `max_lines` and `voice_format` ("opus" or "m4a", which adds each line's audio cache key and URL and NEVER synthesises). COVERAGE IS ONE CORRIDOR, deliberately: the Chelsea riverside, 18 reviewed lines over 5 km. EVERY OTHER ROUTE ANSWERS WITH NO LINES, and that is a correct answer rather than a failure. ALWAYS READ THE CENSUS, which is the record of WHAT WAS NOT SAID: no lines with every entry in `beyond_reach` means this feature does not cover the journey; no lines with entries in `silenced_by_budget` means the corridor is covered and the budget is holding them back. They are different answers and must never be relayed the same way. On the reference route the census reports 1 spoken and 17 silenced, which is the design working, not a thin corpus. Every line publishes `offset_m`, the measured distance from the plaque to the route, because it is the entire warrant for the word "here", and `plaque_ids` so any claim can be taken back to its source. TWO OMISSIONS ARE DELIBERATE: no line says anything is visible, still standing or unchanged (a plaque records that somebody was somewhere, and nothing more), and NO LINE SAYS WHICH SIDE OF THE ROAD anything is on, because nothing in the source records it and a look that finds nothing spends the driver's trust in everything else. Do not add either. COSTS 1 UNIT a call: it reads no tiles and opens no archive. Requires the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY).
| Argument | Type | Description |
|---|---|---|
| max_lines | integer | null |
List the canonical place categories you can pass as `category` to `nearby_places` and `search_along_route` (and browse on with `geocode`). Each entry is a `category` token (the exact value to send, e.g. "fuel", "charging_station", "hgv_parking"), the `aliases` that colloquially name it ("petrol station", "EV charger", "lorry park"), and a one-line `description` of what it covers. Read this before guessing a category: a token that is not on this list matches nothing, and quietly returns an empty result rather than an error. Cuisines, brands and names are NOT categories, search those as free text. Sorted by category and identical on every call. Local lookup, no network, no quota.
No arguments.
{
"type": "object",
"properties": {}
}List everything a MapMap style theme can style: the first-party named bases a style can start from (pass one as `create_style`'s `base`, or as the static-map API's `style=`), the named palette slots with their light/dark default colours, the skeleton layer ids (paint order) that `set_layer_paint` accepts, the OpenMapTiles source-layers extra layers may reference, the insertion slots (`bottom`, `middle`, `top`) an extra layer may name, and the rules for a theme's own `sources` (your data by https URL). Attribution is enforced on every compiled style and cannot be themed away. Local lookup, no network; always works.
No arguments.
{
"type": "object",
"properties": {}
}Snap a recorded GPS trace to the road network and say what it actually travelled over. Provide `shape` (2 to 2000 recorded points, oldest first) or `encoded_polyline` (the same trace as a polyline6 string) (not both) plus the `costing` it was travelled under: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". Costing decides which roads the trace may match onto, so a walk matched as "auto" snaps to the carriageway rather than the footpath. Returns the matched path as `geometry_polyline6` (the snapped roads, not your raw points) with its `distance_m` and `duration_s`, then the roll-ups: `by_road_class` and `by_admin` (distance and time, longest first), `by_surface` (distance), and `toll`, `bridge` and `tunnel` totals. This is how you turn a dashcam or telematics log into a report, which country and region the driving happened in, how much of it was motorway, how much was tolled, how much was unpaved. Honesty: the roll-ups are summed per matched road segment, so they need not add up to `distance_m` exactly, and segments the map records no surface or admin area for are left out of that breakdown rather than filed under a guess, an entry in `by_admin` with null codes is exactly that, counted and not attributed. Needs the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY); there is no direct-backend fallback.
| Argument | Type | Description |
|---|---|---|
| shape | array | null | The trace as an ordered list of recorded points, oldest first. Between 2 and 2000 points. Provide this or `encoded_polyline`. |
| costing | any | Costing model the trace was travelled under: `auto` (default), `truck`, `bicycle`, `pedestrian` or `motor_scooter`. It decides which roads the trace may be matched onto, so a walked trace matched as `auto` snaps to the carriageway rather than the path. |
| encoded_polyline | string | null | The trace as a Google encoded polyline with six digits of decimal precision (polyline6), the geometry `route` and `match_trace` themselves return. Provide this or `shape`. |
Compute a travel time/distance matrix between origins (rows) and destinations (columns). Costing "auto", "truck" (with optional `truck` profile as in `route`), "bicycle", "pedestrian" or "motor_scooter". Returns durations_s[i][j] in seconds and distances_m[i][j] in metres; null cells are unreachable pairs. Up to 10,000 cells per call (origins × destinations). Optional `exclude_polygons` for before/after scenarios ("close this bridge and recompute the matrix"): an array of polygons, each an array of [lon, lat] pairs forming one ring (longitude FIRST) whose intersecting roads are excluded from every cell's path finding. Applies to the Valhalla engine; unsupported on the GraphHopper engine, where it is ignored.
| Argument | Type | Description |
|---|---|---|
| truck | any | Truck profile (dimensions + ADR declaration). Requires costing "truck". |
| costing | any | Costing model: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| origins* | array | Origin locations (matrix rows). |
| destinations* | array | Destination locations (matrix columns). |
| exclude_polygons | array | null | Areas to avoid, scenario analysis ("close this bridge and recompute the matrix"): an array of polygons, each an array of `[lon, lat]` pairs forming one exterior ring (GeoJSON-style, longitude FIRST). Roads intersecting any ring are excluded from every cell's path finding. Applies to the Valhalla engine; unsupported on the GraphHopper engine, where it is ignored. |
Find places near a point, nearest first with distance in metres, by category (cafes, fuel, EV charging, parking), by name or brand ("the nearest Lloyds bank", "nearest Sainsbury's"), or both. Use this instead of geocode whenever the question is about what is NEAR a location: geocode ranks a brand's branches everywhere and only biases by proximity, so it will happily return a Lloyds in another city over the one 100 m away. Provide `lat`, `lon` and at least one of `category` or `name`. `category` is matched against the map's lowercased OSM tag values (amenity/shop/tourism/…), e.g. "cafe", "fuel", "charging_station", "parking", "pharmacy", "supermarket", "hotel", "restaurant", "fast_food", "atm", "bakery", "hospital", "station"; common colloquial names are normalised ("coffee" -> cafe, "ev_charging" -> charging_station, "petrol" -> fuel, "chemist" -> pharmacy). `name` matches the place's name or alternative names word by word, case- and accent-insensitively, with the last word also matching as a prefix. Combine the two to disambiguate a brand, "Lloyds" plus "bank" excludes Lloyds Pharmacy. A category or name the map does not carry returns an empty list, never an error. Optional `radius_m` (default 2500, max 100000) bounds the straight-line search distance and `limit` (default 5, max 10) the result count. Each result has name, one-line label, lat/lon, address parts, distance_m, categories and a `details` object of display tags (opening_hours, website, phone, ...) when the map carries them. Every result also carries `bearing_deg` and a spoken `direction`. Pass `heading_deg` (degrees clockwise from true north, 0 = north, 90 = east) and results are described from where the user stands, "ahead and slightly to your right, about 80 metres", with a signed `relative_bearing_deg` (negative left, positive right); without a heading the phrasing falls back to cardinals ("to the north-east"), so this works with or without a compass. Add `fov_deg` to keep only what lies within that cone of the heading, it is the FULL width of the cone, so 90 keeps what lies within 45 degrees either side of dead ahead; anything dropped is counted in `out_of_view`, so a non-zero count means there ARE matching places nearby, just not in front of the user, say that rather than "nothing nearby". Prefer reading `direction` aloud over coordinates. Requires the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY).
| Argument | Type | Description |
|---|
England bus and coach stops near a point, nearest first. Pass `lat` and `lon` (WGS84), optional `radius_m` (1 to 2,000, default 500) and `limit` (1 to 50, default 10). Each stop carries its NaPTAN ATCO code `id` (pass it to `next_departures`), `name`, `indicator` (e.g. "Stop S"), `locality`, position, `distance_m` and `bearing_deg` from the point, and `lines`, the line names the Bus Open Data timetables have calling there. Bus and coach only: rail, tram, metro and ferry stops are not included, and coverage is England (plus stops just across a border that an England service calls at). Display data, never a journey plan: pass on the returned `label` and `coverage`. Requires the MapMap gateway; a deployment without the stops index answers a clear error. Display the returned `attribution` (NaPTAN and BODS, Open Government Licence v3.0).
| Argument | Type | Description |
|---|---|---|
| lat* | number | Latitude of the point, WGS84 degrees. |
| lon* | number | Longitude of the point, WGS84 degrees. |
| limit | integer | null | Most stops to return, 1 to 50 (default 10), nearest first. |
| radius_m | integer | null | Search radius in metres, 1 to 2,000 (default 500). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude of the point, WGS84 degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of the point, WGS84 degrees."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "uint8",
"maximum": 255,
"minimum": 0,
"description": "Most stops to return, 1 to 50 (default 10), nearest first."
},
"radius_m": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Search radius in metres, 1 to 2,000 (default 500)."
}
}
}Timetabled bus departures at one stop, from the Bus Open Data (BODS) timetables. Pass `stop` (the NaPTAN ATCO code `nearby_stops` returns), optional `at` (RFC 3339, default now; the index holds three service days from today), `window_minutes` (1 to 180, default 60) and `limit` (1 to 30, default 8). Each departure carries `line`, `destination`, `operator`, `scheduled_at` (local time) and `trip`, plus `live` when a vehicle on that line was seen in the live positions within 3 km and heading towards the stop (`vehicle`, `distance_m`, `age_s`). These are TIMETABLE times: `basis` is always "timetable", and a live entry is an observation, never an arrival time or a delay. MapMap does not predict arrivals: never present `scheduled_at` or `live` as one, and pass on the returned `label` and `coverage` verbatim. Requires the MapMap gateway; a deployment without the departures index answers a clear error. Display the returned `attribution` (NaPTAN and BODS, Open Government Licence v3.0).
| Argument | Type | Description |
|---|---|---|
| at | string | null | Start of the window, RFC 3339 (e.g. "2026-10-12T08:00:00+01:00"); default now. The index holds three service days from today. |
| stop* | string | The stop's NaPTAN ATCO code, as `nearby_stops` returns it. |
| limit | integer | null | Most departures to return, 1 to 30 (default 8). |
| window_minutes | integer | null | Window length, 1 to 180 minutes (default 60). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"stop"
],
"properties": {
"at": {
"type": [
"string",
"null"
],
"description": "Start of the window, RFC 3339 (e.g. \"2026-10-12T08:00:00+01:00\");\ndefault now. The index holds three service days from today."
},
"stop": {
"type": "string",
"description": "The stop's NaPTAN ATCO code, as `nearby_stops` returns it."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "uint8",
"maximum": 255,
"minimum": 0,
"description": "Most departures to return, 1 to 30 (default 8)."
},
"window_minutes": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Window length, 1 to 180 minutes (default 60)."
}
}
}Optimise multi-vehicle, multi-stop delivery plans (VRP). Provide `vehicles` (id, start/end, capacity, skills, time_window), `jobs` (id, location, service_s, delivery/pickup, skills, time_windows) and/or `shipments` (pickup+delivery pairs that ride the same vehicle). Costing "auto", "truck", "bicycle", "pedestrian" or "motor_scooter" (cargo-bike and courier fleets welcome): with a `truck` profile (dimensions + ADR declaration, as in `route`), the travel-time matrix respects dimensional and dangerous-goods restrictions, so every optimised route is truck-legal. Returns a summary, unassigned tasks and per-vehicle routes with ordered steps (arrival_s/duration_s in seconds, distance_m in metres). Fair use: at most 200 unique locations per problem, and no wider than the routing engine's matrix span (1,500 km on the hosted endpoint for motor costings, 400 km stock on a self-host). Past that, cluster the stops with `cluster` and optimise each group, or submit the whole problem to the asynchronous lane with `submit_optimise_job` (2,000 locations). Optional `territories` are named polygons ([{id, polygon}], GeoJSON [lon, lat] rings, LONGITUDE FIRST) that bound who serves what: a vehicle listing `territory_ids` may serve a task only if that task sits inside at least one of the territories it names, while a vehicle listing none is unrestricted and may serve anything, inside a round or outside every one. The response's `territories` block says which vehicle was eligible for what and names any task no vehicle could take. A vehicle may also declare `reloads` {max_trips 2-5, reload_time_s, depot?} to return to a depot, reload and go out again, the tipping round. It needs a `time_window`, because the shift is what gets split: it is cut into that many consecutive non-overlapping windows separated by the reload time, each trip carrying the vehicle's FULL capacity and task caps. That split is fixed BEFORE the solve, so the plan is conservative and never optimistic, it cannot put a lorry in two places at once, but it is an approximation: a trip that finishes early cannot lend its spare time to the next, so stops can come back unassigned that a truly sequential model would have served, and `max_trips` is a budget rather than a prediction (ask for five on a shift that supports three and every window shrinks to a fifth). Read the returned `reloads` block before quoting arrival times, and re-plan after each tip with `replan_routes` for the tighter answer. `relax_if_unassigned` {time_windows_by_s?, allow_overtime_s?} re-solves ONCE with those relaxations if the first plan left work unassigned, and the `relaxation` block says honestly which plan came back: at most one second solve, never beyond the caps stated, and the relaxed plan is returned ONLY if it assigns more work than the first. Breaks are never widened, a driver's rest is not a preference to trade for a fuller van , and neither are capacities, skills, territories or task caps; only time windows move. It bills as two solves when the second one runs. Always check `relaxation.relaxed_plan_used` before telling anyone the day fits: a plan produced under relaxation has had promises moved. `emissions` {vehicle_category, fuel, euro_standard} annotates the plan with the clean-air zones its own stops sit in and what this vehicle pays in each; add `avoid_zones: true` to steer the travel-time matrix out of them, which changes the plan itself. Territories, reloads, relaxation and zones are computed by the MapMap gateway; without one configured the tool refuses rather than returning a plan that quietly ignored them. Returns `view_url`, a mapmap.ai link that draws the answer on a map (no key needed); the link carries the stop coordinates and names.
Put a single run's stops in the best visiting order ("order my errands"). Provide `start` {lat, lon} and `stops` (1-100 entries of {location, label?, service_s?}); optionally an `end` destination or `round_trip`: true to return to the start. Costing "auto" = car, "truck" = lorry (pass `truck` as in `route` for a truck-legal order). Returns the stops in visit order with arrival offsets in seconds, plus total duration and distance.
| Argument | Type | Description |
|---|---|---|
| end | any | Optional fixed final destination. Mutually exclusive with `round_trip`; omitted (and not a round trip), the run ends at whichever stop the solver visits last. |
| start* | any | Where the run starts. |
| stops* | array | The stops to put in the best visiting order (1–100). |
| truck | any | Truck profile (dimensions + ADR declaration); requires costing "truck". The travel-time matrix then respects dimensional and dangerous-goods restrictions. |
| costing | any | Costing model: "auto" (default) or "truck". |
| round_trip | boolean | Return to `start` after the last stop (default false). |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
},
"OrderStopSpec": {
"type": "object",
"required": [
"location"
],
"properties": {
"label": {
"type": [
"string",
"null"
],
"description": "Human-readable label echoed back in the ordered plan\n(e.g. \"chemist\" or \"site B\")."
},
"location": {
"$ref": "#/$defs/LatLon",
"description": "The stop's location."
},
"service_s": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "On-site time in seconds (waiting, loading, shopping)."
}
},
"description": "One errand stop of an `order_stops` request."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start",
"stops"
],
"properties": {
"end": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Optional fixed final destination. Mutually exclusive with\n`round_trip`; omitted (and not a round trip), the run ends at\nwhichever stop the solver visits last."
},
"start": {
"$ref": "#/$defs/LatLon",
"description": "Where the run starts."
},
"stops": {
"type": "array",
"items": {
"$ref": "#/$defs/OrderStopSpec"
},
"description": "The stops to put in the best visiting order (1–100)."
},
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration); requires costing\n\"truck\". The travel-time matrix then respects dimensional and\ndangerous-goods restrictions."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model: \"auto\" (default) or \"truck\"."
},
"round_trip": {
"type": "boolean",
"default": false,
"description": "Return to `start` after the last stop (default false)."
}
}
}What is over THERE: given a position and the direction the user is facing, the places inside that cone, and whether the ground and the buildings in between let them actually be seen. Use this for "what is that over there", "is there a pub in that direction", "what am I looking at". Use `nearby_places` instead when the question is about what is NEAR a point rather than what is in a direction. Provide `lat`, `lon`, `bearing_deg` (degrees CLOCKWISE FROM TRUE NORTH: 0 north, 90 east, 180 south, 270 west) and at least one of `category` or `name`; `category=building` reaches named buildings. Optional `fov_deg` is the FULL width of the cone (default 60, so 30 degrees either side), `radius_m` the range (default 1000, max 5000), `eye_height_m` the observer's eye height (default 1.6). Each result carries `distance_m`, `bearing_deg`, a signed `angular_offset_deg` (negative left, positive right), a spoken `direction`, and a `visibility` block. READ THE VISIBILITY BLOCK BEFORE SAYING ANYTHING: `clear` means nothing in the data stands in the way, `occluded` names what does (a hill, or a building with its height), and `unknown` means NO check could run: with `unknown` say you cannot tell, never that it is visible. Read `basis` too: `terrain-only` in a town means hills were checked and buildings were not, which is weak. A non-zero `out_of_sector` means there ARE matching places nearby, just not in that direction, so say that rather than "nothing nearby". `coverage` names the datasets that answered and `caveat` is the standing limit: visibility is modelled from maps, not observed, and trees, walls, scaffolding and weather are not in it. Requires the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY).
| Argument | Type | Description |
|---|---|---|
| lat* | number | Latitude of the observer in decimal degrees (−90 to 90). |
| lon* | number | Longitude of the observer in decimal degrees (−180 to 180). |
| name | string | null |
Turn an itinerary into one navigable multi-stop route. Provide a `start` and `stops` (each a `location` {lat, lon} or a free-text `name` to geocode, plus optional `dwell_minutes` time at the stop), optional `depart_at` (RFC 3339) for absolute ETAs, `optimise: true` to reorder stops for the shortest day (VROOM solver), and `return_to_start`. Costing "auto", "truck" (with a `truck` profile the whole day respects dimensional/ADR restrictions), "bicycle", "pedestrian" or "motor_scooter". Returns the stops in visit order with per-leg duration/distance and arrival/departure times, totals, and the full route geometry (polyline6). Geocoded names carry a `resolution`, when `ambiguous` is true, check `alternatives` and re-run with an explicit location rather than trusting the guess. Returns `view_url`, a mapmap.ai link that draws the answer on a map (no key needed); the link carries the stop coordinates and names.
| Argument | Type | Description |
|---|---|---|
| start* | any | Where the day starts (name or location; `dwell_minutes` ignored). |
| stops* | array | The stops to visit (1–20). Visited in the given order unless `optimise` is true. |
| truck | any | Truck profile (dimensions + ADR declaration). Requires costing "truck". |
| costing | any | Costing model: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| optimise | boolean | Reorder the stops for the shortest day (VROOM solver; requires the optimisation sidecar). Default false: visit in the given order. |
Order a handful of errands against a hard arrival time, and say honestly whether they fit. This is the "pick up a prescription, get petrol, and be at the school by quarter past three" tool. Give `origin`, `destination` (+ `destination_name`), `arrive_by` (RFC 3339 with an offset: convert "quarter past three" yourself), optional `depart_at`, and 1 to 5 `errands`. Each errand is EITHER a `category` (a kind of place: "pharmacy", "fuel", "supermarket", or a colloquial phrase the server normalises; use `list_place_categories` for the vocabulary) OR a `place` {lat, lon} the driver already knows ("the school", "the nursery"). Resolve a named place with `geocode` first and pass the coordinate: never invent one. Optional `dwell_minutes` per errand (default 5). The server chooses the order and the actual shops, exhaustively, over engine-computed travel times -- do NOT attempt the ordering or the arithmetic yourself. IMPORTANT: `feasible: false` is an ANSWER, not an error to retry. It names the errand that costs the most (`blocking_errand`), says how late the whole chain would be (`over_by_s`), and returns the stops of the chain that DOES fit with `dropped` naming what had to go. Tell the driver what to drop. Every stop is a real indexed place carrying its id: never mention a shop the answer did not return. `hours` is "open_on_the_tag" (the map's tag covers your arrival, which is evidence and not a promise) or "unknown" (most places carry no hours at all); a place the tag proves shut is never proposed. ALWAYS show `usage_note`: this is planned before setting off or by a passenger, never at the wheel. Requires the MapMap gateway.
| Argument | Type | Description |
|---|---|---|
| origin* | any | Where the driver sets off from. |
| errands* | array | The errands, in any order: the answer decides the order. One to five. |
| arrive_by* | string |
Plan a whole electric-vehicle journey, charge stops included. Give `origin` and `destination` (plus optional `waypoints`) and a `vehicle`, a published profile ("small_hatch", "saloon", "suv", "van") and/or inline figures (battery_kwh, mass_kg, drag_area_m2, aux_kw, connectors), with `start_soc` (default 0.9), `min_arrival_soc` (default 0.1), `reserve_soc` (default 0.1, the floor the charge must never drop below mid-route), optional `connectors` and `min_kw` filters and `ambient_temperature_c`. Energy comes from a published road-load physics model over the route's own legs; charge times are integrated over the vehicle's charging curve capped by the charge point, NOT energy divided by peak power, which is the single biggest error in naive EV planners. Returns the stops with arrive/depart state of charge, charge time and detour, a per-leg state-of-charge trace, and the journey's driving and charging time. IMPORTANT: when no plan exists, a charger desert, a connector mismatch, a gap wider than the car's range, the answer comes back with `feasible: false`, a `reason` and the furthest point on the route the car can actually reach. That is an ANSWER, not an error to retry: report the reason and never describe it as a plan. `gradient_data` says whether elevation was available: "absent" means consumption was modelled on the flat and under-reads a hilly route. There is no national charge-point registry, so ALWAYS show the returned `coverage_note`, an infeasible plan means "none from these operators", never "there are no chargers here", and statuses are current only when `availability_live` is true. Requires the MapMap gateway; answers a clear error when the deployment has no charge-point dataset. Display the returned charging_attribution with the plan.
| Argument | Type | Description |
|---|---|---|
| min_kw | number | null | Keep only charge points with a usable connector rated at least this many kW (e.g. 50 for rapid charging only). |
| origin* | any | Where the journey starts. |
Compute the area reachable from an origin within one or more travel-time budgets, walkability/cyclability rings. Costing "pedestrian" answers "how far can I walk in 15 minutes?", "bicycle" the cycling equivalent; "auto", "truck" and "motor_scooter" work too (e.g. delivery coverage). `contours_minutes` lists the ring boundaries in minutes (1 to 4 values, each up to 120); set `polygons` true for filled polygons ready to render as a map fill layer instead of contour lines. Returns a GeoJSON FeatureCollection, one feature per contour. The origin is first moved onto the nearest road the travel mode can use (ferries excluded, at most 5 km away) and the rings are drawn from there: `snapped_origin` {lat, lon, distance_m} on the collection and on every feature's properties says where. An origin with no road within 5 km (open sea, desert, an unmapped area) is refused with "no roads near this point" rather than answered with a speck, and that refusal is not billed; move it onto land near a road. Optional `exclude_polygons` for before/after scenarios ("close this bridge and recompute reachability"): an array of polygons, each an array of [lon, lat] pairs forming one ring, longitude FIRST, whose intersecting roads are excluded from the reachability search. Applies to the Valhalla engine; unsupported on the GraphHopper engine, where it is ignored.
| Argument | Type | Description |
|---|---|---|
| origin* | any | Origin the reachable area is computed from. |
| costing | any | Travel mode: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| polygons | boolean | null | Return filled polygons instead of contour linestrings (default false). Polygons draw directly as a MapLibre fill layer. |
| contours_minutes* | array |
Re-plan a fleet part-way through its shift. Send the day back; nothing is stored. MapMap holds NO dispatch state, no plan, no vehicle position, no completion log, so a re-plan is not a delta against something we remember: you pass the ORIGINAL `optimise_routes` problem in full, plus `progress` (per vehicle: `completed_stop_ids` IN THE ORDER SERVED, an optional `current_position`, and `unavailable: true` for a breakdown or an end of hours) and/or `changes` (`cancel_job_ids`, `add_jobs`, `add_shipments`), and get a fresh plan for what is left. That costs bandwidth and buys the absence of a server-side plan that can go stale, leak, or fall out of step with the telematics platform that actually owns the truth, and it makes a re-plan reproducible: the same body always yields the same answer. Completed stops are LOCKED by construction: they are removed from the problem entirely and each vehicle starts from where it actually is, so the solver cannot move a stop that has already happened, a guarantee the solver cannot break, rather than a hint it is free to ignore. At least one progress entry or one change is required. Returns the same plan shape as `optimise_routes` for the REMAINING work, plus a `replan` block: the prefix locked per vehicle, where each re-plans from and how that was decided, stops released from a vehicle that can no longer serve them, tasks forced unassigned, and a note for every id that did not resolve. Read that block, a stop that vanished from the plan is named there rather than left for a dispatcher to notice at four in the afternoon; a cancelled id that matched nothing is reported there too rather than refused. Multi-trip vehicles cannot be re-planned: a completion does not say which trip it belongs to, so a problem whose vehicles declare `reloads` is refused with what to send instead. Billed on the remaining problem, not the original. Requires the MapMap gateway.
| Argument | Type | Description |
|---|---|---|
| jobs | array | Single-stop jobs (at least one job or shipment overall). |
| truck | any | Truck profile (dimensions + ADR declaration). Requires costing "truck"; the travel-time matrix then respects dimensional and dangerous-goods restrictions, so the whole plan is truck-legal. |
Report that the live world disagrees with the map, a closed road, a wrong or missing restriction, a bad speed limit, a missing road, a wrong one-way, or changed access. Use it when you observe the mismatch mid-task. Provide `location` {lat, lon}, a `category` (road_closed, wrong_restriction, wrong_speed_limit, missing_road, wrong_oneway, access_changed, other) and optionally a `description`, the OSM `way_id` and an `evidence_url`. This is a first-party observation: it is QUEUED for human/agent review and NEVER changes routing immediately or edits any map. Returns the queued report_id.
| Argument | Type | Description |
|---|---|---|
| way_id | integer | null | The OSM way id the observation concerns, when the caller knows it. Optional, the report stands on its own as a first-party observation and is never tied to OSM data beyond this hint. |
| category* | any | What kind of mismatch this is. |
| location* | any | Where the mismatch was observed (WGS84 decimal degrees). |
| description | string | null | Free-text detail of what was observed on the ground, e.g. "barrier across the lane, diversion signed via the B4009". Bounded length. |
| evidence_url | string | null | A URL backing the observation (photo, notice, news item), when one exists. Bounded length. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"MapIssueCategory": {
"oneOf": [
{
"type": "string",
"const": "road_closed",
"description": "A road the map shows as open is closed (roadworks, collapse, event)."
},
{
"type": "string",
"const": "wrong_restriction",
"description": "A turn/access/dimension/weight restriction is wrong or missing."
},
{
"type": "string",
"const": "wrong_speed_limit",
"description": "The posted speed limit differs from the map's value."
},
{
"type": "string",
"const": "missing_road",
"description": "A road exists on the ground but is absent from the map."
},
{
"type": "string",
"const": "wrong_oneway",
"description": "A one-way direction is wrong (or the road is not one-way at all)."
},
{
"type": "string",
"const": "access_changed",
"description": "Access has changed (e.g. now gated, private, or newly public)."
},
{
"type": "string",
"const": "other",
"description": "Anything else that does not fit the categories above."
}
],
"description": "The kind of map/live-world mismatch an agent is reporting.\n\nA first-party *observation* only: it records what the agent saw on the\nground, never an edit to any map or OSM-derived database."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"location",
"category"
],
"properties": {
"way_id": {
"type": [
"integer",
"null"
],
"format": "uint64",
"minimum": 0,
"description": "The OSM way id the observation concerns, when the caller knows it.\nOptional, the report stands on its own as a first-party\nobservation and is never tied to OSM data beyond this hint."
},
"category": {
"$ref": "#/$defs/MapIssueCategory",
"description": "What kind of mismatch this is."
},
"location": {
"$ref": "#/$defs/LatLon",
"description": "Where the mismatch was observed (WGS84 decimal degrees)."
},
"description": {
"type": [
"string",
"null"
],
"description": "Free-text detail of what was observed on the ground, e.g. \"barrier\nacross the lane, diversion signed via the B4009\". Bounded length."
},
"evidence_url": {
"type": [
"string",
"null"
],
"description": "A URL backing the observation (photo, notice, news item), when one\nexists. Bounded length."
}
}
}Turn coordinates into the nearest places: addresses, POIs and localities with distance in metres. The inverse of geocode. Provide `lat` and `lon`; returns up to `limit` (default 5, max 10) results, nearest first, each with name, one-line label, lat/lon, type, address parts and distance_m, plus categories and a `details` object of display tags (opening_hours, website, phone, wikipedia, ...) on POI hits when the index carries them. Every result also carries `bearing_deg` and a spoken `direction`. Pass `heading_deg` (degrees clockwise from true north, 0 = north, 90 = east) and results are described from where the user stands, "ahead and slightly to your right, about 80 metres", with a signed `relative_bearing_deg` (negative left, positive right); without a heading the phrasing falls back to cardinals ("north-east of you"), so this works with or without a compass. Add `fov_deg` to keep only what lies within that cone of the heading, it is the FULL width, so 90 keeps what lies within 45 degrees either side of dead ahead; anything dropped is counted in `out_of_view`. Prefer reading `direction` aloud over coordinates.
| Argument | Type | Description |
|---|---|---|
| lat* | number | Latitude in decimal degrees (−90 to 90). |
| lon* | number | Longitude in decimal degrees (−180 to 180). |
| limit | integer | null | Maximum number of results (1–10, default 5). The hosted first-party index answers at most 5 nearest hits per lookup. |
| fov_deg | number | null | Field of view: the full width in degrees of a cone centred on `heading_deg`, outside which results are dropped, it is the FULL width, so 90 keeps only what lies within 45 degrees either side of dead ahead. Needs `heading_deg`, a cone has to point somewhere. The count of results removed is reported as `out_of_view`. |
Compute a turn-by-turn route between origin and destination (optionally via waypoints). Costing "auto" = car, "truck" = lorry, "bicycle", "pedestrian" = walking, "motor_scooter" = moped. Pass `truck` {height_m, width_m, length_m, gross_weight_t, hazmat, tunnel_code} to apply dimensional limits and the ADR dangerous-goods tunnel matrix to the search; `pedestrian` {use_lit 0-1, type "wheelchair"|"blind", max_hiking_difficulty 1-6, use_hills 0-1, max_grade_pct 1-90, surface_quality "avoid"|"ignore"} for lit-street walking, wheelchair routing and trail limits. A wheelchair route through the MapMap gateway returns a `grade` block (maximum grade, ascent and descent sampled from a 30 m elevation model, the `use_hills` preference sent, and `cap.enforced` for a `max_grade_pct`, which the engine accepts but does not enforce yet: say so) and, where the deployment has a surface graph, a `surface_quality` block: `applied: true` means ways rated smoothness bad or worse in OpenStreetMap were avoided in the named region, a preference from ratings where they exist that says nothing about kerbs, widths, steps or inclines; `applied: false` gives the `reason`. Relay both caveats and never describe such a route as suitable for every user; `bicycle` {bicycle_type, use_roads 0-1, use_living_streets 0-1, avoid_bad_surfaces 0-1, use_hills 0-1} for quiet-ride and surface preferences. Returns distance (m), duration (s), maneuvers, polyline6 geometry and the ADR costing that was applied. Any of truck, auto, bicycle, pedestrian or motor_scooter routes may set `rationale: true` (opt-in, costs up to 1 + N extra routing calls) to learn which declared truck constraints or avoidance-side preferences (hills, surfaces, tolls, unlit streets, …) actually changed the route (`rationale.avoided[]`, basis route_divergence, it proves a field was binding, it does not identify the physical restriction or feature, and no live traffic or incident data is ever attributed). ADR honesty: `applied_adr.forbidden_tunnel_categories` describes the LOAD, not the returned route, and `applied_adr.tunnel_enforcement` states the boundary: roads are excluded only where the routing graph records an ADR tunnel category, so an unchanged route is not a clearance. Set `landmarks: true` for turn instructions anchored to recognisable places, each manoeuvre that passes one gains a `landmark_instruction` like "Turn right just after the Shell garage" beside the engine's own street-name `instruction`, which is never replaced. Prefer reading it aloud: it is how a passenger gives directions. Nothing is named unless it is recognisable from the road, within 40 m of the junction and not tagged as closed, so many routes return none and a `landmarks.annotated` of 0 with no `note` means this route genuinely passes nothing recognisable. Needs the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY), whose place index does the lookup. Through the gateway each manoeuvre also carries the road it starts on: `country`, `subdivision`, `ref` (route numbers only), `road_class`, `speed_limit_unit` (`mph` or `km/h`, from the road's country), `speed_limit_sign` (`vienna` or `mutcd`), `speed_limit_posted` (the limit as the sign shows it, in the road's unit) and `driving_side`; each is absent when the map does not know it, never guessed. Optional `exclude_polygons` for what-if scenarios ("close this bridge and re-route"): an array of polygons, each an array of [lon, lat] pairs forming one ring (longitude FIRST) whose intersecting roads are excluded from the search. Applies to the Valhalla engine; unsupported on the GraphHopper engine, where it is ignored. Optional `avoid` and `exclude` name road features to keep off, and the difference between them is not cosmetic. `avoid` ("tolls", "highways", "ferries") is a PREFERENCE: it sets the costing's willingness to zero, and the engine's own reference says that is not guaranteed to avoid the feature, measured, avoiding tolls across the Dartford Crossing returns the same tolled route, because the untolled alternative is fifty kilometres further. `exclude` ("tolls", "highways", "ferries", "bridges", "tunnels") is a hard exclusion: it can answer NO ROUTE rather than a detour, and it depends on the routing engine's own hard-exclusion setting, which the engine does not report and this server cannot read, so it is requested, never promised. "tolls" and "highways" under `avoid` exist only on motorised costings; asking for one on a bicycle is refused rather than silently ignored. Whatever is applied comes back in `avoidance`, with the caveats, relay them, because "avoid tolls" read as a guarantee is the failure mode here. Each location also takes a kerbside approach: `preferred_side` "same" (alias "curb") stops on the door's side of the road, resolved against the locale's driving side, the left kerb in the UK, the right in Germany, with "opposite" and "either" (alias "unrestricted") for the rest. It is a snapping preference, not a manoeuvre guarantee, and it needs a coordinate genuinely offset from the road centreline; `street_side_tolerance_m` and `street_side_max_distance_m` bound the window in which it applies, and a pair leaving no window is refused rather than answered with the preference silently inert. Pass `emissions` {vehicle_category, fuel, euro_standard} for UK clean-air-zone assessment: the response's `zones` block then names every zone the route enters and what THIS vehicle pays there, with the publishing authority cited. Without it a zone can only be named, never priced. Needs the gateway, which holds the curated zone dataset; the whole dataset, every scheme, charge, boundary and provenance record, is readable at `GET /v1/zones` on the HTTP API when an agent needs to audit a figure or list zones without routing. Set `scenic: true` (auto costing only) to ask whether there is a prettier way. It is a PEER OFFER, never a substitution: the route in `geometry_polyline6` is byte-for-byte what the same request returns without the flag, and the prettier way, when there is one, arrives beside it in `scenic`, with its own geometry in `scenic.alternative_geometry_polyline6` and what it costs in `scenic.spoken` ("About seven minutes longer than the quick way"). EVERY OFFER STATES ITS REASON OR THERE IS NO OFFER: a route that scores well but cannot support a plain sentence is dropped rather than dressed up, so a `scenic.reason` of null means nothing here measured above the floor. That is an ANSWER, not a failure, and it is the one to relay. A REJECTION IS ALSO AN ANSWER: every candidate that lost says why in `scenic.rejections[]` (`same_route`, `no_scenic_gain`, `not_scenic_enough`, `over_time_budget` with the minutes it would have cost, `nothing_to_say`), so "no prettier way" is always attributable and raising the budget is an informed choice. It is a re-ranking of routes the engine already proposed, not a scenic search: a beautiful road the engine never offered was never considered, and `scenic.caveats` says so. Like `rationale`, IT COSTS EXTRA METERED COMPUTATIONS, at most two, which is why it is opt-in and never on by default. `available: false` with a `note` means this deployment could not look, which is not the same claim as nothing being there. Needs the gateway, whose basemap archive the scoring is measured against. Returns `view_url`, a mapmap.ai link that draws the answer on a map (no key needed); the link carries the stop coordinates and names.
What a journey PASSES, in sentences ready to be read aloud, each with its position along the route. The named rivers and canals it crosses, the road it runs on and for how far, the settlements it goes through, the protected landscapes it enters and how high the road climbs: the things a passenger who knew the area would say. NONE OF THIS IS IN A ROUTE: a route is a list of movements and a river crossing is not a movement, so do not try to read it out of `route`'s answer. Give `geometry_polyline6` straight from the `route` tool, plus optional `units` ("miles" default, or "kilometers"), `min_gap_m` and `max_observations`. Each observation carries `at_m` (WHERE it belongs (delivered anywhere else it is trivia, not an observation), a `kind`, a `say` sentence to relay verbatim, and a `basis` naming the map layer and tag the claim rests on. THE SILENCE BUDGET IS THE DESIGN: `min_gap_m` is a floor, not a target, and when a route yields more than `max_observations` the gap WIDENS on its own so the survivors stay spread over the whole journey rather than clustering where the map happened to be richest. Inside a window the rarer kind wins. So a short list on a long route is the budget working, not thin data. READ `coverage` BEFORE REPORTING AN EMPTY LIST: an empty `observations` with `tiles_read` of 0 means NO DATA WAS READ, which is not the same claim as quiet countryside, and `uncovered_m` says how much of the route could not be seen at all. Two things it will never say, deliberately: it never names a hill (a peak two kilometres away behind a ridge is named confidently and seen by nobody), and it never reads a junction number (an observation mistakable for an instruction is not safe to speak beside real guidance). A settlement is a labelled POINT, not a boundary, and `offset_m` publishes the distance behind the word "through". It is a query and it triggers nothing: no position is held and nothing is pushed. COSTS 10 UNITS a call, flat, whatever is asked for. Requires the MapMap gateway (GATEWAY_URL + GATEWAY_API_KEY), whose basemap archive and elevation model answer it; a deployment with no archive answers 501 and says so.
| Argument | Type | Description |
|---|---|---|
| units | string | null | Units for the spoken distances: `miles` (default) or `kilometers`. `kilometres` and `km` are accepted too. |
Find places (POIs) along a route with the REAL extra travel time of stopping at each, never a straight-line guess. Provide `origin` + `destination` (a route is computed) or an existing route's `geometry_polyline6`, plus a free-text `query` ("coffee", "EV charger", "truck stop") and `max_detour_minutes` (default 10). For a category intent ("fuel", "EV charger", "coffee") pass `category` instead of relying on words alone: it takes the same vocabulary as `nearby_places` (lowercased OSM tag values such as "fuel", "cafe", "charging_station", "parking", "pharmacy"), and common colloquial phrases are normalised server-side ("petrol station" and "gas station" to fuel, "coffee" to cafe, "EV charger" to charging_station). `query` alone also promotes a pure category phrase to the same browse, so "fuel" finds fuel stations rather than places whose NAME starts "Ful"; anything else stays free-text name matching. When a browse ran, the response echoes the tokens used in `matched_categories`. Candidates near the route corridor are priced through the routing engine with your costing: detour = (origin→place) + (place→destination) − (origin→destination). Costing "auto", "truck" (with a `truck` profile the detours respect dimensional/ADR restrictions), "bicycle", "pedestrian" or "motor_scooter". Returns results sorted by detour with detour_minutes, detour_km, along_route_position (0-1) and off_route_m; at most 25 candidates are priced per call (candidate_cap).
| Argument | Type | Description |
|---|---|---|
| query* | string | Free-text POI query, e.g. "coffee", "EV charger", "truck stop". |
| truck | any | Truck profile (dimensions + ADR declaration). Requires costing "truck"; the detours then respect dimensional/ADR restrictions. |
| origin | any | Route origin (with `destination`, when no geometry is given). |
| costing |
Set one MapLibre paint property on one skeleton layer of a hosted style (e.g. layer_id "road-major", property "line-width", value 4 or an expression array) and publish the result as a new immutable style version. Layer ids come from list_style_layers. Returns the new version and style URL.
| Argument | Type | Description |
|---|---|---|
| value* | any | The paint value (any MapLibre-valid JSON: number, colour string or expression array). |
| layer_id* | string | Skeleton layer id, e.g. "road-major". Call `list_style_layers` for the accepted ids. |
| property* | string | MapLibre paint property name, e.g. "line-width" or "fill-color". |
| style_id* | string | Hosted style id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"style_id",
"layer_id",
"property",
"value"
],
"properties": {
"value": {
"description": "The paint value (any MapLibre-valid JSON: number, colour string or\nexpression array)."
},
"layer_id": {
"type": "string",
"description": "Skeleton layer id, e.g. \"road-major\". Call `list_style_layers`\nfor the accepted ids."
},
"property": {
"type": "string",
"description": "MapLibre paint property name, e.g. \"line-width\" or \"fill-color\"."
},
"style_id": {
"type": "string",
"description": "Hosted style id."
}
}
}Recolour one or more palette slots of a hosted style (e.g. {"water": "#0b2038", "roadMajor": "#8a6d3b"}) and publish the result as a new immutable style version. Slot names come from list_style_layers; colours are CSS (#rgb/#rrggbb/#rrggbbaa/rgb()/hsl()). Returns the new version and style URL.
| Argument | Type | Description |
|---|---|---|
| colours* | object | Palette overrides: slot name → CSS colour (e.g. {"water": "#0b2038"}). Call `list_style_layers` for the slot names. |
| style_id* | string | Hosted style id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"style_id",
"colours"
],
"properties": {
"colours": {
"type": "object",
"description": "Palette overrides: slot name → CSS colour (e.g.\n{\"water\": \"#0b2038\"}). Call `list_style_layers` for the slot names.",
"additionalProperties": {
"type": "string"
}
},
"style_id": {
"type": "string",
"description": "Hosted style id."
}
}
}OPERATOR WRITE, ADMIN ONLY. Asserts a short-lived closure (`assert: {kind: closed}`) or speed (`{kind: speed_override, speed_kph}`, 1 to 120) on named OSM `way_ids` (1 to 20) and `direction` (forward, backward or both, default both), for `ttl_secs` (60 to 86400), with a `reason` and an optional `evidence_url`. The record expires on its own, ranks below official closures and is logged with the reason. NEVER CALL THIS WITHOUT A PERSON'S EXPLICIT APPROVAL OF THIS EXACT CLOSURE IN THIS CONVERSATION: draft it, show it, stop, and call it only after a yes. Available only where the operator runs sn-mcp locally with SN_CAMERA_INCIDENTS_ENABLED=true and SN_ADMIN_TOKEN set; everywhere else it refuses and says why. Whether a live traffic writer applies it is reported in `applied_by_live_writer`; false means the record is stored but no road changes.
| Argument | Type | Description |
|---|---|---|
| assert* | any | `closed` or a speed in km/h (1..=120). |
| reason* | string | Why, for the audit log and the incidents endpoint note. |
| way_ids* | array | OSM way ids to assert on; at most 20. |
| ttl_secs* | integer | Lifetime, seconds, 60..=86400. |
| direction | any | Carriageway, default `both`. |
| evidence_url | string | null | Evidence link, if any. |
The planetary Kp index and the NOAA SWPC OVATION aurora forecast right now. No input. Returns `kp` (0 to 9) with its time, the forecast's valid time, the peak aurora probability and `aurora_png_url` (a 360 by 181 probability grid, percent per pixel, column 0 at 180 W, row 0 at 90 N) when the forecast is under an hour old; `status` is `unavailable` when it is older and nothing should be drawn. A FORECAST about 30 to 90 minutes ahead, not an observation; never present it as a sighting or a guarantee. Requires the MapMap gateway. Display the returned `attribution`; no endorsement by NOAA is implied.
No arguments.
{
"type": "object",
"properties": {}
}Send MapMap a structured integration retro (problems, gotchas, wins, docs gaps). Call at most once, after your MapMap integration works or you stop trying, and only if the developer has approved sending feedback to MapMap. Sends ONLY the structured fields in this schema to MapMap: there is no field for a transcript, a prompt, source code, file contents or coordinates. The free-text fields are short and capped, but they are still free text: do NOT paste code, credentials, customer names or personal data into them. Provide `what_built` (required), `problems` [{area: sdk|api|mcp|docs|billing|self-host|other, description, workaround_found}], `gotchas`, `wins`, `docs_gaps`, and optionally `agent_name` and `sdk_version`.
| Argument | Type | Description |
|---|---|---|
| wins | array | What went well (at most 20 entries × 500 bytes). |
| gotchas | array | Surprises/traps worth documenting (at most 20 entries × 500 bytes). |
| problems | array | Problems hit during the integration (at most 20). |
| docs_gaps | array | Documentation gaps hit (at most 20 entries × 500 bytes). |
| agent_name | string | null | The submitting agent's name, e.g. "Claude Code" (at most 100 bytes). |
| what_built* | string | What was built with MapMap, in one or two sentences (required, at most 500 bytes). |
| sdk_version |
Submit a problem too large to solve inside one request to the asynchronous lane, and get a job id back. Set `kind` to "optimise", "replan" or "matrix", and pass `problem` in EXACTLY the shape the matching synchronous tool takes, `optimise_routes` input, `replan_routes` input, or `matrix` input. Moving a working synchronous call onto this lane changes nothing but which tool you call it with. A field that tool's input does not have is REFUSED by name rather than dropped: the HTTP API accepts some the MCP tools have not surfaced yet, and a job queued without a constraint you asked for is worse than one that was never queued. The ceilings are far higher here because there is no request to hold open: 2,000 unique locations for an optimisation or re-plan against the synchronous 200, and 40,000 matrix elements against 10,000 (a deployment may set either lower, in which case its own refusal is the authority). A re-plan is counted on the REMAINING problem, after completed stops are removed, so a shift well through its day may fit where the morning's would not. This answers 202-and-a-job-id, NOT a plan: the job is queued and a worker picks it up. Poll `get_job` with the returned id until it says the status is terminal, then read the result. Polling is free, the gateway meters this submission, not the reads. Units are charged on submission and handed back in full if the job fails. The optional `webhook_url` (https only) posts a SIGNED notification when the job finishes and is for a human wiring infrastructure that must react without a process watching; it carries a pointer, never the result, and needs a webhook signing secret on the key. An agent that can poll should not use it. Requires the MapMap gateway.
| Argument | Type | Description |
|---|---|---|
| kind* | any | Which problem this is. It selects both the body shape below and the ceiling the submission is judged against. |
| problem* | any | The problem itself, in exactly the shape the synchronous tool takes , `optimise_routes` input for `optimise`, `replan_routes` input for `replan`, `matrix` input for `matrix`. Moving a working synchronous call onto this lane changes nothing but the tool you call it with. |
Check whether a dataset's DECLARED coordinate reference system actually describes its own coordinates, before you draw it on a map. Catches the failures that are otherwise silent: swapped lat/lon axes, degrees labelled as metres, and Web Mercator or another projection mislabelled with a UTM or national-grid code. Pass the declared CRS (e.g. "EPSG:4326") and a sample of the raw coordinates as {x, y} in the dataset's OWN units, deliberately not named lon/lat, because whether they are degrees is the question. Returns a verdict (consistent / suspect / impossible), what is wrong in plain language, and where the numbers actually point when read another way. This is a sanity check, not a reprojection: it never transforms coordinates. Local computation: no network call, no quota.
| Argument | Type | Description |
|---|---|---|
| coordinates* | array | A sample of the dataset's coordinates. A few dozen is plenty; the check is about ranges and spans, not volume. |
| declared_crs* | string | The CRS the dataset claims, e.g. `"EPSG:4326"`, `"EPSG:32610"`, `"EPSG:3857"`, `"EPSG:27700"`. |
{
"type": "object",
"$defs": {
"XY": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "number",
"format": "double"
},
"y": {
"type": "number",
"format": "double"
}
},
"description": "One coordinate from the dataset, in the dataset's own units, NOT\nnecessarily degrees. Named `x`/`y` rather than `lon`/`lat` precisely\nbecause whether they are degrees is the thing in question."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"declared_crs",
"coordinates"
],
"properties": {
"coordinates": {
"type": "array",
"items": {
"$ref": "#/$defs/XY"
},
"description": "A sample of the dataset's coordinates. A few dozen is plenty; the\ncheck is about ranges and spans, not volume."
},
"declared_crs": {
"type": "string",
"description": "The CRS the dataset claims, e.g. `\"EPSG:4326\"`, `\"EPSG:32610\"`,\n`\"EPSG:3857\"`, `\"EPSG:27700\"`."
}
}
}Check whether places (and itineraries) an AI mentioned are real, findable and physically possible. Pass structured `claims` (reliable, and the only path that supports itinerary feasibility) or free `text` (best-effort quoted-phrase extraction). Each claim resolves to exactly one of three verdicts, never a boolean: "verified" (matched a real place, with its stable id and the source/date of the evidence), "contradicted" (a specific, dated, sourced fact rules it out, currently only an itinerary leg the routing engine proves cannot be driven in the stated time, with the computed travel time as evidence), or "unverified" (no evidence either way). This tool NEVER asserts that a named real business does not exist or has closed, that would be a defamation risk with no upside; a missing match is always "unverified". Claims sharing increasing `sequence` values and both carrying `claimed_time` (ISO 8601) form itinerary legs checked for feasibility via `matrix`, catching e.g. "breakfast in Bath, 10am meeting in Edinburgh". Max 20 claims per request. A claim takes only `id`, `name`, `locality`, `sequence` and `claimed_time`; any other field (e.g. `near`) is refused naming the accepted ones, so put disambiguating context such as a town in `locality`. The response's `summary` field is a concise plain-text digest (also returned as this tool result's text content) so clients that drop structured/non-text content blocks still see the verdicts.
| Argument | Type | Description |
|---|---|---|
| text | string | null | Free text to extract place claims from (best-effort heuristic: quoted phrases and Title Case runs after "at/in/near/to/from/ visiting", not NLP or an LLM call, and it does not attempt itinerary feasibility since there are no explicit times to anchor legs to). Mutually exclusive with `claims`. Max 8,000 characters. |
| claims | array | null | Structured claims, the reliable path, and the only path that supports itinerary feasibility. Mutually exclusive with `text`. Max 20 per request. |
| costing |
Forecast weather along a route, each sample read for the hour you actually reach it rather than the weather right now. Pass the route's `shape` (an encoded polyline6, the `route` tool's geometry_polyline6), optional `depart_at` (RFC 3339, default now), the route's `duration_s` (from `route`; omitted, an 80 km/h average is assumed and `duration_source` says so) and optional `sample_interval_m` (default 25,000, 5,000 to 100,000, at most 40 samples). Each sample carries its ETA, temperature, rain, snowfall, precipitation type and probability, wind and gust speed, visibility, the WMO weather code and `severe` (thunderstorm and heavy precipitation codes only). It is a FORECAST, not an observation: read on a 0.05 degree grid (about 5.5 km) at the nearest hour, up to 16 days ahead, and samples past that horizon or without data come back `available: false` with a reason, never painted dry. `summary` is one sentence (where rain or snow starts and for how far, the strongest gust, samples without data) and always ends by saying it is advisory, never a routing guarantee: keep that qualifier when you pass it on. Requires the MapMap gateway; a deployment without a weather source answers a clear error. Display the returned `attribution` with the forecast, linked to `attribution_url`, with `licence_url` (CC BY 4.0) linked; `derived_fields` names the sample fields MapMap derives rather than Open-Meteo supplies.
| Argument | Type | Description |
|---|---|---|
| shape* | string | The route shape as an encoded polyline6 (the `route` tool's `geometry_polyline6`). |
| depart_at | string | null | Departure time, RFC 3339 (e.g. "2026-10-12T14:00:00Z"); defaults to now. Forecasts reach about 16 days ahead; samples past that answer unavailable. |
| duration_s | number | null | The route's duration in seconds, used to work out when you reach each sample. Pass the `route` tool's duration; omitted, a generic 80 km/h average is assumed and `duration_source` says so. |
The NOAA GFS forecast frames MapMap publishes for drawing weather on a map: 17 frames (0 to 48 hours every 3 hours) of the newest run, each with URLs for the global rain, temperature, cloud, gust and sea-level pressure PNG fields (1440 by 721, value-encoded; decode with `encodings`), the wind field (PNG plus JSON ranges) and XYZ tile templates for rain, temperature and isobars. Optional `run` (YYYYMMDDHH) and `fields`. The URLs need the caller's own MapMap key. A FORECAST, not an observation, processed by MapMap from NOAA GFS 0.25 degree data (regridded and quantised): never describe it as original NOAA data or imply NOAA endorsement. `status` says whether the newest run is fresh. Requires the MapMap gateway. Display the returned `attribution`.
| Argument | Type | Description |
|---|---|---|
| run | string | null | A forecast run as YYYYMMDDHH (UTC), e.g. "2026101700". Default: the newest run. |
| fields | array | null | Which fields to return URLs for, any of `rain`, `temp`, `cloud`, `gust`, `mslp`, `wind`, `isobars`. Default: all. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"run": {
"type": [
"string",
"null"
],
"description": "A forecast run as YYYYMMDDHH (UTC), e.g. \"2026101700\". Default: the\nnewest run."
},
"fields": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Which fields to return URLs for, any of `rain`, `temp`, `cloud`,\n`gust`, `mslp`, `wind`, `isobars`. Default: all."
}
}
}| origin | any | Route origin (with `destination`, when no geometry is given). |
| costing | any | Costing model for the route and detour matrix: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| connectors | array | null | Keep only charge points offering at least one of these connector standards: "type2", "type1", "ccs", "chademo", "tesla", "domestic" or "other". Omitted ⇒ every standard. |
| destination | any | Route destination. |
| max_results | integer | null | Maximum results (default 5, at most 25). |
| available_only | boolean | null | Keep only charge points with a bay reported free right now. Needs the deployment to have a live availability feed; without one the call is refused rather than silently returning nothing. |
| geometry_polyline6 | string | null | An existing route geometry as an encoded polyline6 (the `route` tool's `geometry_polyline6`). Provide either this or `origin` + `destination`, not both. |
| max_detour_minutes | number | null | Largest acceptable detour in minutes (default 10, at most 120). |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"; the detours then respect dimensional/ADR restrictions."
},
"min_kw": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Keep only charge points whose best connector is rated at least this\nmany kW (e.g. 50 for rapid charging only)."
},
"origin": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Route origin (with `destination`, when no geometry is given)."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model for the route and detour matrix: \"auto\" (default),\n\"truck\", \"bicycle\", \"pedestrian\" or \"motor_scooter\"."
},
"connectors": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Keep only charge points offering at least one of these connector\nstandards: \"type2\", \"type1\", \"ccs\", \"chademo\", \"tesla\", \"domestic\"\nor \"other\". Omitted ⇒ every standard."
},
"destination": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Route destination."
},
"max_results": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum results (default 5, at most 25)."
},
"available_only": {
"type": [
"boolean",
"null"
],
"description": "Keep only charge points with a bay reported free right now. Needs\nthe deployment to have a live availability feed; without one the\ncall is refused rather than silently returning nothing."
},
"geometry_polyline6": {
"type": [
"string",
"null"
],
"description": "An existing route geometry as an encoded polyline6 (the `route`\ntool's `geometry_polyline6`). Provide either this or `origin` +\n`destination`, not both."
},
"max_detour_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Largest acceptable detour in minutes (default 10, at most 120)."
}
}
}| Truck profile (dimensions + ADR declaration). Requires costing "truck"; the detours then respect dimensional/ADR restrictions. |
| origin | any | Route origin (with `destination`, when no geometry is given). |
| costing | any | Costing model for the route and detour matrix: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| destination | any | Route destination. |
| fill_litres | number | null | Optional fill size in litres; each result then also carries `saving_total` = `saving_per_litre` × `fill_litres`. |
| max_results | integer | null | Maximum results (default 5, at most 25). |
| geometry_polyline6 | string | null | An existing route geometry as an encoded polyline6 (the `route` tool's `geometry_polyline6`). Provide either this or `origin` + `destination`, not both. |
| max_detour_minutes | number | null | Largest acceptable detour in minutes (default 10, at most 120). |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"fuel": {
"type": [
"string",
"null"
],
"description": "Which fuel to price: \"diesel\" (default), \"petrol_95\", \"petrol_98\",\n\"premium_diesel\", \"e85\" or \"lpg\" (aliases \"petrol\", \"unleaded\",\n\"e10\", \"super_unleaded\", \"e5\", \"b7\" and \"sdv\" are accepted)."
},
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"; the detours then respect dimensional/ADR restrictions."
},
"origin": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Route origin (with `destination`, when no geometry is given)."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model for the route and detour matrix: \"auto\" (default),\n\"truck\", \"bicycle\", \"pedestrian\" or \"motor_scooter\"."
},
"destination": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Route destination."
},
"fill_litres": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Optional fill size in litres; each result then also carries\n`saving_total` = `saving_per_litre` × `fill_litres`."
},
"max_results": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum results (default 5, at most 25)."
},
"geometry_polyline6": {
"type": [
"string",
"null"
],
"description": "An existing route geometry as an encoded polyline6 (the `route`\ntool's `geometry_polyline6`). Provide either this or `origin` +\n`destination`, not both."
},
"max_detour_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Largest acceptable detour in minutes (default 10, at most 120)."
}
}
}| number | null |
| Vehicle width in metres. Supplying it asks the width axis as well as the height axis; the width answer is reported separately and is never a headroom. |
| height_m* | number | Vehicle height in metres. Required: there is no default vehicle, because a default vehicle is how somebody gets an answer about a lorry that is not theirs. |
| margin_m | number | null | Operating margin in metres, added to the height before the verdict is decided (default 0). Your compliance policy, not ours: the measured figure and the safe bound are both reported whatever you set here, and the margin is echoed back. It is applied to the measurement, not to the routing step, where the map's own posted heights already carry a margin of their own. |
| destination* | any | Route destination. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"origin",
"destination",
"height_m"
],
"properties": {
"origin": {
"$ref": "#/$defs/LatLon",
"description": "Route origin."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres. Supplying it asks the width axis as well as\nthe height axis; the width answer is reported separately and is\nnever a headroom."
},
"height_m": {
"type": "number",
"format": "double",
"description": "Vehicle height in metres. Required: there is no default vehicle,\nbecause a default vehicle is how somebody gets an answer about a\nlorry that is not theirs."
},
"margin_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Operating margin in metres, added to the height before the verdict\nis decided (default 0). Your compliance policy, not ours: the\nmeasured figure and the safe bound are both reported whatever you\nset here, and the margin is echoed back. It is applied to the\nmeasurement, not to the routing step, where the map's own posted\nheights already carry a margin of their own."
},
"destination": {
"$ref": "#/$defs/LatLon",
"description": "Route destination."
}
}
}| array |
| The stops to group. Ids must be unique; at most 5,000. |
| territories | array | null | Optional territories. Given, no cluster straddles one: each territory is clustered on its own, and so are the stops inside none of them. |
| max_cluster_load | number | null | At most this much summed `load` per cluster; the cluster count is derived from it. A load ceiling with lumpy loads is a bin-packing problem and may have no solution at the derived count, the response says so rather than pretending. |
| max_cluster_locations | integer | null | At most this many stops per cluster; the cluster count is derived from it. |
{
"type": "object",
"$defs": {
"TerritorySpec": {
"type": "object",
"required": [
"id",
"polygon"
],
"properties": {
"id": {
"type": "string",
"description": "Caller-chosen id, echoed back and referenced by\n`vehicles[].territory_ids`. Must be unique within the request."
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2
},
"description": "The outer ring as GeoJSON `[lon, lat]` positions, longitude\nFIRST. Closed or open; an unclosed ring is closed for you."
}
},
"description": "One named territory: a polygon that bounds which vehicle may serve\nwhich stop."
},
"ClusterLocationSpec": {
"type": "object",
"required": [
"id",
"lat",
"lon"
],
"properties": {
"id": {
"type": "string",
"description": "Caller-chosen id, echoed back as the cluster's membership. Must be\nunique within the request."
},
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees."
},
"load": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Optional weight, parcels, kilograms, litres, minutes of service.\nSummed per cluster and reported; constrains the clustering only\nunder `max_cluster_load`."
}
},
"description": "One stop to be clustered."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"locations"
],
"properties": {
"seed": {
"type": [
"integer",
"null"
],
"format": "uint64",
"minimum": 0,
"description": "Seed for the k-means++ seeding (default 42). The same request with\nthe same seed always returns the same clusters, on every\ndeployment."
},
"clusters": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "How many clusters to produce, balanced by stop count. Give exactly\none of `clusters`, `max_cluster_locations` or `max_cluster_load`."
},
"locations": {
"type": "array",
"items": {
"$ref": "#/$defs/ClusterLocationSpec"
},
"description": "The stops to group. Ids must be unique; at most 5,000."
},
"territories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/TerritorySpec"
},
"description": "Optional territories. Given, no cluster straddles one: each\nterritory is clustered on its own, and so are the stops inside none\nof them."
},
"max_cluster_load": {
"type": [
"number",
"null"
],
"format": "double",
"description": "At most this much summed `load` per cluster; the cluster count is\nderived from it. A load ceiling with lumpy loads is a bin-packing\nproblem and may have no solution at the derived count, the\nresponse says so rather than pretending."
},
"max_cluster_locations": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "At most this many stops per cluster; the cluster count is derived\nfrom it."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"bbox"
],
"properties": {
"bbox": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 4,
"minItems": 4,
"description": "Bounding box `[west, south, east, north]`, WGS84 degrees. West must\nbe less than east and south less than north; a box crossing the\nantimeridian is not supported (query two boxes)."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"description": "Most events to return, 1 to 500 (default 100). Newest quakes\nfirst, then volcano alerts, then the busiest fire cells."
},
"types": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Which feeds to include: any of `quake`, `volcano`, `fire`. Default:\nall three."
},
"min_magnitude": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Smallest earthquake magnitude, 2.5 to 9.0 (default 2.5). Quakes\nonly."
}
}
}| focus | any | Optional location bias: results near this point rank higher. |
| limit | integer | null | Maximum number of results (1–50, default 10). |
| query | string | null | Free-text place query, e.g. "Dover ferry terminal". Required unless at least one structured component is supplied. |
| street | string | null | Structured component: street name, e.g. "Downing Street". Matches the street of addresses and POIs (transliterated street names included) as well as the street itself. |
| country | string | null | Structured component: ISO 3166-1 alpha-2 code or country name, "GB", "gb", "United Kingdom" and "UK" all mean the same country. A value naming no country is refused rather than quietly applied as a filter that matches nothing. |
| postcode | string | null | Structured component: postcode in any spacing or case, "SW1A 2AA" and "sw1a2aa" are one query. A bare UK outward code ("SW1A") selects the whole district. |
| housenumber | string | null | Structured component: house number, e.g. "10" or "221B". Only meaningful alongside `street`, a house number on its own excludes nearly everything and identifies nothing. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": [
"string",
"null"
],
"description": "Structured component: town or city, e.g. \"London\". Matches the\ncontaining city as well as the immediate locality, so a suburb name\nworks here too."
},
"lang": {
"type": [
"string",
"null"
],
"description": "Language of the place names to match and return, as a two-letter\ncode. Defaults to \"en\", which is what makes English exonyms\n(\"Munich\", \"Cologne\", \"Geneva\") resolve to the place meant rather\nthan a same-named town elsewhere. Set it to the language your\nquery is written in; \"default\" asks for each place's own local\nname. Deployments support a fixed set (this one: \"en\", \"de\",\n\"fr\"), and anything outside it is refused."
},
"focus": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Optional location bias: results near this point rank higher."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum number of results (1–50, default 10)."
},
"query": {
"type": [
"string",
"null"
],
"description": "Free-text place query, e.g. \"Dover ferry terminal\". Required unless\nat least one structured component is supplied."
},
"street": {
"type": [
"string",
"null"
],
"description": "Structured component: street name, e.g. \"Downing Street\". Matches\nthe street of addresses and POIs (transliterated street names\nincluded) as well as the street itself."
},
"country": {
"type": [
"string",
"null"
],
"description": "Structured component: ISO 3166-1 alpha-2 code or country name,\n\"GB\", \"gb\", \"United Kingdom\" and \"UK\" all mean the same country.\nA value naming no country is refused rather than quietly applied as\na filter that matches nothing."
},
"postcode": {
"type": [
"string",
"null"
],
"description": "Structured component: postcode in any spacing or case, \"SW1A 2AA\"\nand \"sw1a2aa\" are one query. A bare UK outward code (\"SW1A\")\nselects the whole district."
},
"housenumber": {
"type": [
"string",
"null"
],
"description": "Structured component: house number, e.g. \"10\" or \"221B\". Only\nmeaningful alongside `street`, a house number on its own excludes\nnearly everything and identifies nothing."
}
}
}| Ceiling on how many lines come back, 1 to 50 (default 12). |
| min_gap_m | number | null | Least distance between two lines, metres (default 400). A floor under the time budget in every case. |
| min_gap_s | number | null | Least time between two lines, seconds (default 900, which is four an hour). Applied only with `duration_s`. |
| duration_s | number | null | That route's own duration, seconds: `duration_s` from the same answer. **Supply it.** Without it the silence budget falls back to a distance, and "three to five lines an hour" is a claim about time that a distance answers wrongly at both ends. |
| max_offset_m | number | null | How near a plaque must come to the route before its line may be spoken, metres (default 60, hard ceiling 80). |
| voice_format | string | null | Container to address each line's audio clip in: `opus` or `m4a`. Given, every line gains a `clip` with its synthesis cache key and URL. It NEVER synthesises: the key is a pure function of the sentence, so asking here buys nothing. |
| geometry_polyline6* | string | The route shape, precision-6 encoded: `geometry_polyline6` straight out of the `route` tool's answer. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"geometry_polyline6"
],
"properties": {
"max_lines": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Ceiling on how many lines come back, 1 to 50 (default 12)."
},
"min_gap_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Least distance between two lines, metres (default 400). A floor\nunder the time budget in every case."
},
"min_gap_s": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Least time between two lines, seconds (default 900, which is four\nan hour). Applied only with `duration_s`."
},
"duration_s": {
"type": [
"number",
"null"
],
"format": "double",
"description": "That route's own duration, seconds: `duration_s` from the same\nanswer. **Supply it.** Without it the silence budget falls back to\na distance, and \"three to five lines an hour\" is a claim about\ntime that a distance answers wrongly at both ends."
},
"max_offset_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "How near a plaque must come to the route before its line may be\nspoken, metres (default 60, hard ceiling 80)."
},
"voice_format": {
"type": [
"string",
"null"
],
"description": "Container to address each line's audio clip in: `opus` or `m4a`.\nGiven, every line gains a `clip` with its synthesis cache key and\nURL. It NEVER synthesises: the key is a pure function of the\nsentence, so asking here buys nothing."
},
"geometry_polyline6": {
"type": "string",
"description": "The route shape, precision-6 encoded: `geometry_polyline6`\nstraight out of the `route` tool's answer."
}
}
}{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"shape": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "The trace as an ordered list of recorded points, oldest first.\nBetween 2 and 2000 points. Provide this or `encoded_polyline`."
},
"costing": {
"anyOf": [
{
"$ref": "#/$defs/CostingKind"
},
{
"type": "null"
}
],
"description": "Costing model the trace was travelled under: `auto` (default),\n`truck`, `bicycle`, `pedestrian` or `motor_scooter`. It decides\nwhich roads the trace may be matched onto, so a walked trace\nmatched as `auto` snaps to the carriageway rather than the path."
},
"encoded_polyline": {
"type": [
"string",
"null"
],
"description": "The trace as a Google encoded polyline with six digits of decimal\nprecision (polyline6), the geometry `route` and `match_trace`\nthemselves return. Provide this or `shape`."
}
}
}{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"origins",
"destinations"
],
"properties": {
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model: \"auto\" (default), \"truck\", \"bicycle\", \"pedestrian\"\nor \"motor_scooter\"."
},
"origins": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "Origin locations (matrix rows)."
},
"destinations": {
"type": "array",
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "Destination locations (matrix columns)."
},
"exclude_polygons": {
"type": [
"array",
"null"
],
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2
}
},
"description": "Areas to avoid, scenario analysis (\"close this bridge and\nrecompute the matrix\"): an array of polygons, each an array of\n`[lon, lat]` pairs forming one exterior ring (GeoJSON-style,\nlongitude FIRST). Roads intersecting any ring are excluded from\nevery cell's path finding. Applies to the Valhalla engine;\nunsupported on the GraphHopper engine, where it is ignored."
}
}
}| lat* | number | Latitude of the search point in decimal degrees (−90 to 90). |
| lon* | number | Longitude of the search point in decimal degrees (−180 to 180). |
| name | string | null | The name or brand of the place to find, "Lloyds", "Lloyds Bank", "Sainsbury's", for "where is the nearest X" questions. Every word must appear in the place's name or one of its alternative names, case- and accent-insensitively, with the last word also matching as a prefix ("Sains" finds Sainsbury's). Combine with `category` to disambiguate a brand used by more than one kind of place ("Lloyds" plus "bank" excludes Lloyds Pharmacy). Optional when `category` is given; at least one of the two is required. |
| limit | integer | null | Maximum number of results (1–10, default 5). |
| fov_deg | number | null | Field of view: the full width in degrees of a cone centred on `heading_deg`, outside which results are dropped, it is the FULL width, so 90 keeps only what lies within 45 degrees either side of dead ahead. Needs `heading_deg`, a cone has to point somewhere. The count of results removed is reported as `out_of_view`. |
| category | string | null | The kind of place to find. The gateway matches it against the index's lowercased OSM tag values (the value of the POI's `amenity`/`shop`/`tourism`/`railway`/… tag), e.g. "cafe", "fuel", "charging_station", "parking", "pharmacy", "supermarket", "hotel", "restaurant", "fast_food", "atm", "bakery", "hospital", "station", and normalises common colloquial names first ("coffee" → cafe; "ev_charging", "ev charging" → charging_station; "petrol" → fuel; "chemist" → pharmacy). A category the index does not carry matches nothing: the result is an empty list, not an error. Optional when `name` is given; at least one of the two is required. |
| radius_m | integer | null | Maximum straight-line distance of any result from the point, in metres (1–100000, default 2500). |
| heading_deg | number | null | Which way the user is facing, in degrees **clockwise from true north** (0 = north, 90 = east, 180 = south, 270 = west). Supply it and every result is also described from the user's point of view ("just ahead on your right"); omit it and results fall back to cardinal directions ("to the north-east"), so the tool works with or without a compass. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude of the search point in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of the search point in decimal degrees (−180 to 180)."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name or brand of the place to find, \"Lloyds\", \"Lloyds Bank\",\n\"Sainsbury's\", for \"where is the nearest X\" questions. Every word\nmust appear in the place's name or one of its alternative names,\ncase- and accent-insensitively, with the last word also matching as\na prefix (\"Sains\" finds Sainsbury's). Combine with `category` to\ndisambiguate a brand used by more than one kind of place (\"Lloyds\"\nplus \"bank\" excludes Lloyds Pharmacy). Optional when `category` is\ngiven; at least one of the two is required."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum number of results (1–10, default 5)."
},
"fov_deg": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Field of view: the full width in degrees of a cone centred on\n`heading_deg`, outside which results are dropped, it is the\nFULL width, so 90 keeps only what lies within 45 degrees either\nside of dead ahead. Needs\n`heading_deg`, a cone has to point somewhere. The count of\nresults removed is reported as `out_of_view`."
},
"category": {
"type": [
"string",
"null"
],
"description": "The kind of place to find. The gateway matches it against the\nindex's lowercased OSM tag values (the value of the POI's\n`amenity`/`shop`/`tourism`/`railway`/… tag), e.g. \"cafe\", \"fuel\",\n\"charging_station\", \"parking\", \"pharmacy\", \"supermarket\", \"hotel\",\n\"restaurant\", \"fast_food\", \"atm\", \"bakery\", \"hospital\", \"station\",\nand normalises common colloquial names first (\"coffee\" → cafe;\n\"ev_charging\", \"ev charging\" → charging_station; \"petrol\" → fuel;\n\"chemist\" → pharmacy). A category the index does not carry matches\nnothing: the result is an empty list, not an error. Optional when\n`name` is given; at least one of the two is required."
},
"radius_m": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum straight-line distance of any result from the point, in\nmetres (1–100000, default 2500)."
},
"heading_deg": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Which way the user is facing, in degrees **clockwise from true\nnorth** (0 = north, 90 = east, 180 = south, 270 = west). Supply it\nand every result is also described from the user's point of view\n(\"just ahead on your right\"); omit it and results fall back to\ncardinal directions (\"to the north-east\"), so the tool works with\nor without a compass."
}
}
}| Argument | Type | Description |
|---|---|---|
| jobs | array | Single-stop jobs (at least one job or shipment overall). |
| truck | any | Truck profile (dimensions + ADR declaration). Requires costing "truck"; the travel-time matrix then respects dimensional and dangerous-goods restrictions, so the whole plan is truck-legal. |
| costing | any | Costing model for the travel-time matrix: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| vehicles* | array | The fleet (at least one vehicle, each with a start and/or end). |
| emissions | any | The fleet's emission declaration, for UK clean-air / low-emission zone assessment. On its own it annotates: the response's `zones` block names every zone containing one of the problem's own locations and what this vehicle would pay there. With `avoid_zones` it also steers the internal travel-time matrix away from those zones, so the plan itself changes. |
| shipments | array | Pickup+delivery pairs. |
| avoid_zones | boolean | null | Keep the optimisation's travel-time matrix out of every zone the declared vehicle would be charged or banned in. Requires `emissions`. |
| territories | array | null | Fleet territories: named polygons that bound which vehicle may serve which stop, referenced by `vehicles[].territory_ids`. These are request data, caller-drawn rounds, validated per call and never stored. Nothing to do with clean-air zones or with the offline map packages of the same word. |
| relax_if_unassigned | any | Re-solve ONCE with these relaxations if the first solve leaves work unassigned, and say honestly which plan came back. At most one second solve, never beyond the caps you state, and the relaxed plan is returned only if it assigns MORE work than the first, giving away constraints for nothing is strictly worse than not giving them away. Breaks are never widened, nor are capacities, skills, territories or task caps: only time windows move, and only by the stated amounts. Bills as two solves when the second one runs. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"RelaxSpec": {
"type": "object",
"properties": {
"allow_overtime_s": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Extend every vehicle's shift END by this many seconds. Shift starts\nare never moved earlier, a driver cannot begin before they begin."
},
"time_windows_by_s": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Widen every task time window by this many seconds at EACH end. A\n09:00–12:00 window with 1800 becomes 08:30–12:30."
}
},
"description": "What the caller is willing to give up if the first solve leaves work\nunassigned. At least one field is required."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
},
"ReloadsSpec": {
"type": "object",
"required": [
"max_trips"
],
"properties": {
"depot": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Where the vehicle reloads. Omitted, its own `start` is used (or its\n`end` if it declared only that)."
},
"max_trips": {
"type": "integer",
"format": "uint32",
"minimum": 0,
"description": "How many trips this vehicle may run in its shift, 2–5. A BUDGET,\nnot a prediction: the shift is cut into that many fixed windows\nbefore the solve, so asking for five trips on a shift that supports\nthree shrinks every window to a fifth and can make the whole day\nworse. Ask for the number of trips you actually expect to run."
},
"reload_time_s": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Seconds at the depot between trips, tipping, reloading, the\nweighbridge. Held out of the shift before it is partitioned, so it\nis never accidentally spent driving."
}
},
"description": "A vehicle's multi-trip reload plan."
},
"EmissionsFuel": {
"oneOf": [
{
"type": "string",
"const": "petrol",
"description": "Petrol, including petrol hybrids (schemes rate a hybrid by its\ncombustion engine's approval)."
},
{
"type": "string",
"const": "diesel",
"description": "Diesel, including diesel hybrids."
},
{
"type": "string",
"const": "electric",
"description": "Battery-electric."
},
{
"type": "string",
"const": "hydrogen",
"description": "Hydrogen fuel cell."
},
{
"type": "string",
"const": "gas",
"description": "LPG or CNG; rated as petrol by every scheme in the dataset."
}
],
"description": "What a vehicle burns, in clean-air-zone scheme terms."
},
"EmissionsSpec": {
"type": "object",
"required": [
"vehicle_category",
"fuel"
],
"properties": {
"fuel": {
"$ref": "#/$defs/EmissionsFuel",
"description": "What it burns."
},
"euro_standard": {
"type": [
"integer",
"null"
],
"format": "uint8",
"maximum": 255,
"minimum": 0,
"description": "Its Euro emission standard, 1–6. Heavy-duty approvals are written\nin Roman numerals (Euro VI); declare Euro VI as `6`. Required for\nany combustion fuel, without it no zone can be resolved, and a\nhalf-declared vehicle is indistinguishable from an undeclared one.\nOptional only for `electric` or `hydrogen`."
},
"vehicle_category": {
"$ref": "#/$defs/EmissionsVehicleCategory",
"description": "What kind of vehicle this is, in scheme terms."
}
},
"description": "A vehicle's emission declaration, for clean-air / low-emission zone\nassessment."
},
"TerritorySpec": {
"type": "object",
"required": [
"id",
"polygon"
],
"properties": {
"id": {
"type": "string",
"description": "Caller-chosen id, echoed back and referenced by\n`vehicles[].territory_ids`. Must be unique within the request."
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2
},
"description": "The outer ring as GeoJSON `[lon, lat]` positions, longitude\nFIRST. Closed or open; an unclosed ring is closed for you."
}
},
"description": "One named territory: a polygon that bounds which vehicle may serve\nwhich stop."
},
"OptimiseJobSpec": {
"type": "object",
"required": [
"id",
"location"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "Caller-chosen job id, echoed back in steps and `unassigned`."
},
"pickup": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Quantities picked up at the job (matches vehicle `capacity`)."
},
"skills": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "uint32",
"minimum": 0
},
"description": "Skills the job requires."
},
"delivery": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Quantities delivered to the job (matches vehicle `capacity`)."
},
"location": {
"$ref": "#/$defs/LatLon",
"description": "Job location."
},
"service_s": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "On-site service time in seconds."
},
"time_windows": {
"type": [
"array",
"null"
],
"items": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"description": "Acceptable `[start, end]` windows in seconds."
}
},
"description": "One single-stop job of an optimisation problem."
},
"OptimiseVehicleSpec": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "Caller-chosen vehicle id, echoed back on its route."
},
"end": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "End location; omitted, the route ends at its last stop."
},
"start": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Start location; at least one of `start`/`end` is required."
},
"skills": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "uint32",
"minimum": 0
},
"description": "Skills this vehicle provides."
},
"reloads": {
"anyOf": [
{
"$ref": "#/$defs/ReloadsSpec"
},
{
"type": "null"
}
],
"description": "Let this vehicle return to a depot, reload and go out again, the\nwaste-collection tipping round, the van that comes back for a\nsecond wave of parcels."
},
"capacity": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Multidimensional capacity (same length as job `delivery`/`pickup`)."
},
"time_window": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Working window as `[start, end]` in seconds (any consistent epoch)."
},
"territory_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Ids of the request's `territories` this vehicle may work in.\nOmitted or empty, the vehicle is UNRESTRICTED and may serve any\ntask, inside a territory or outside every one of them. Listed, the\nvehicle may serve a task only if that task sits inside at least one\nof the named territories."
}
},
"description": "One vehicle of an optimisation fleet."
},
"OptimiseShipmentSpec": {
"type": "object",
"required": [
"pickup",
"delivery"
],
"properties": {
"amount": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Quantities moved (matches vehicle `capacity`)."
},
"pickup": {
"$ref": "#/$defs/OptimiseShipmentStopSpec",
"description": "The pickup end."
},
"skills": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "uint32",
"minimum": 0
},
"description": "Skills the shipment requires."
},
"delivery": {
"$ref": "#/$defs/OptimiseShipmentStopSpec",
"description": "The delivery end."
}
},
"description": "A pickup+delivery pair that must ride the same vehicle, pickup first."
},
"EmissionsVehicleCategory": {
"oneOf": [
{
"type": "string",
"const": "car",
"description": "A private car."
},
{
"type": "string",
"const": "van",
"description": "A van or light goods vehicle up to 3.5 tonnes."
},
{
"type": "string",
"const": "minibus",
"description": "A minibus (typically 8+ passenger seats, up to 5 tonnes)."
},
{
"type": "string",
"const": "hgv",
"description": "A heavy goods vehicle over 3.5 tonnes."
},
{
"type": "string",
"const": "bus",
"description": "A bus over 5 tonnes."
},
{
"type": "string",
"const": "coach",
"description": "A coach over 5 tonnes."
},
{
"type": "string",
"const": "taxi",
"description": "A licensed hackney carriage."
},
{
"type": "string",
"const": "phv",
"description": "A private hire vehicle."
},
{
"type": "string",
"const": "motorcycle",
"description": "A motorcycle, moped or tricycle."
},
{
"type": "string",
"const": "motorhome",
"description": "A motor caravan or campervan."
}
],
"description": "What a vehicle is, in clean-air-zone scheme terms.\n\nDeclaring this turns \"charge depends on vehicle emissions\" into an\nanswer. Without it a zone can only be named, never priced."
},
"OptimiseShipmentStopSpec": {
"type": "object",
"required": [
"id",
"location"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "Caller-chosen stop id, echoed back in steps and `unassigned`."
},
"location": {
"$ref": "#/$defs/LatLon",
"description": "Stop location."
},
"service_s": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "On-site service time in seconds."
}
},
"description": "One end (pickup or delivery) of a shipment."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vehicles"
],
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseJobSpec"
},
"description": "Single-stop jobs (at least one job or shipment overall)."
},
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"; the travel-time matrix then respects dimensional and\ndangerous-goods restrictions, so the whole plan is truck-legal."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model for the travel-time matrix: \"auto\" (default),\n\"truck\", \"bicycle\", \"pedestrian\" or \"motor_scooter\"."
},
"vehicles": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseVehicleSpec"
},
"description": "The fleet (at least one vehicle, each with a start and/or end)."
},
"emissions": {
"anyOf": [
{
"$ref": "#/$defs/EmissionsSpec"
},
{
"type": "null"
}
],
"description": "The fleet's emission declaration, for UK clean-air / low-emission\nzone assessment. On its own it annotates: the response's `zones`\nblock names every zone containing one of the problem's own\nlocations and what this vehicle would pay there. With\n`avoid_zones` it also steers the internal travel-time matrix away\nfrom those zones, so the plan itself changes."
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseShipmentSpec"
},
"description": "Pickup+delivery pairs."
},
"avoid_zones": {
"type": [
"boolean",
"null"
],
"description": "Keep the optimisation's travel-time matrix out of every zone the\ndeclared vehicle would be charged or banned in. Requires\n`emissions`."
},
"territories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/TerritorySpec"
},
"description": "Fleet territories: named polygons that bound which vehicle may\nserve which stop, referenced by `vehicles[].territory_ids`. These\nare request data, caller-drawn rounds, validated per call and\nnever stored. Nothing to do with clean-air zones or with the\noffline map packages of the same word."
},
"relax_if_unassigned": {
"anyOf": [
{
"$ref": "#/$defs/RelaxSpec"
},
{
"type": "null"
}
],
"description": "Re-solve ONCE with these relaxations if the first solve leaves work\nunassigned, and say honestly which plan came back. At most one\nsecond solve, never beyond the caps you state, and the relaxed plan\nis returned only if it assigns MORE work than the first, giving\naway constraints for nothing is strictly worse than not giving them\naway. Breaks are never widened, nor are capacities, skills,\nterritories or task caps: only time windows move, and only by the\nstated amounts. Bills as two solves when the second one runs."
}
}
}| A place name or brand to look for. At least one of `category` and `name` is required. |
| limit | integer | null | Maximum number of results (1–25, default 5). |
| fov_deg | number | null | Full width in degrees of the cone centred on `bearing_deg` (1–360, default 60, so 30 degrees either side). The FULL width, not the half angle. |
| category | string | null | The kind of place to look for, from the same vocabulary `nearby_places` uses ("cafe", "pub", "fuel", "charging_station" …). Use "building" to ask what a named building over there is. At least one of `category` and `name` is required. |
| radius_m | integer | null | Maximum straight-line range in metres (1–5000, default 1000). |
| bearing_deg* | number | Which way the observer is facing, in degrees **clockwise from true north** (0 = north, 90 = east, 180 = south, 270 = west). Required: this tool answers "what is over there", and "there" has to point somewhere. |
| eye_height_m | number | null | Height of the observer's eye above the ground in metres (0–500, default 1.6, a standing adult). A driver's eye is nearer 1.2 m. |
| visible_only | boolean | null | When true, return only places whose visibility verdict is `clear`. Default false, which returns everything in the cone WITH its verdict, usually the better answer, because "it is there but you cannot see it from here" is worth saying. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lat",
"lon",
"bearing_deg"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude of the observer in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of the observer in decimal degrees (−180 to 180)."
},
"name": {
"type": [
"string",
"null"
],
"description": "A place name or brand to look for. At least one of `category` and\n`name` is required."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum number of results (1–25, default 5)."
},
"fov_deg": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Full width in degrees of the cone centred on `bearing_deg` (1–360,\ndefault 60, so 30 degrees either side). The FULL width, not the\nhalf angle."
},
"category": {
"type": [
"string",
"null"
],
"description": "The kind of place to look for, from the same vocabulary\n`nearby_places` uses (\"cafe\", \"pub\", \"fuel\", \"charging_station\" …).\nUse \"building\" to ask what a named building over there is. At\nleast one of `category` and `name` is required."
},
"radius_m": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum straight-line range in metres (1–5000, default 1000)."
},
"bearing_deg": {
"type": "number",
"format": "double",
"description": "Which way the observer is facing, in degrees **clockwise from true\nnorth** (0 = north, 90 = east, 180 = south, 270 = west). Required:\nthis tool answers \"what is over there\", and \"there\" has to point\nsomewhere."
},
"eye_height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Height of the observer's eye above the ground in metres (0–500,\ndefault 1.6, a standing adult). A driver's eye is nearer 1.2 m."
},
"visible_only": {
"type": [
"boolean",
"null"
],
"description": "When true, return only places whose visibility verdict is `clear`.\nDefault false, which returns everything in the cone WITH its\nverdict, usually the better answer, because \"it is there but you\ncannot see it from here\" is worth saying."
}
}
}| depart_at |
| string | null |
| Departure time as RFC 3339 (e.g. "2026-07-18T09:00:00Z"); when given, every ETA is also returned as an absolute timestamp. |
| return_to_start | boolean | End the day back at the start (default false). |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
},
"PlanDayStopInput": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "Free-text name or address, geocoded when no `location` is given."
},
"location": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Exact coordinates; skips geocoding."
},
"dwell_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Time spent at the stop in minutes (default 0); shifts every later\nETA."
}
},
"description": "One stop of a `plan_day` itinerary: an exact location, or a free-text\nname to geocode (ambiguous matches are flagged in the response, never\nguessed silently)."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start",
"stops"
],
"properties": {
"start": {
"$ref": "#/$defs/PlanDayStopInput",
"description": "Where the day starts (name or location; `dwell_minutes` ignored)."
},
"stops": {
"type": "array",
"items": {
"$ref": "#/$defs/PlanDayStopInput"
},
"description": "The stops to visit (1–20). Visited in the given order unless\n`optimise` is true."
},
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model: \"auto\" (default), \"truck\", \"bicycle\", \"pedestrian\"\nor \"motor_scooter\"."
},
"optimise": {
"type": "boolean",
"default": false,
"description": "Reorder the stops for the shortest day (VROOM solver; requires the\noptimisation sidecar). Default false: visit in the given order."
},
"depart_at": {
"type": [
"string",
"null"
],
"description": "Departure time as RFC 3339 (e.g. \"2026-07-18T09:00:00Z\"); when\ngiven, every ETA is also returned as an absolute timestamp."
},
"return_to_start": {
"type": "boolean",
"default": false,
"description": "End the day back at the start (default false)."
}
}
}| The hard arrival time, RFC 3339 with an offset ("2026-09-21T15:15:00+01:00"). Convert "quarter past three" to an absolute instant in the driver's own offset before calling. |
| depart_at | string | null | When they set off, RFC 3339. Defaults to now. |
| destination* | any | Where they have to be by `arrive_by`. |
| destination_name | string | null | What to call the destination in the answer ("the school"). |
| max_detour_minutes | number | null | How far off the direct route a candidate place may sit, as a detour in minutes (default 12, at most 45). |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"ErrandSpec": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "What to call this errand in the answer (\"prescription\", \"petrol\").\nDefaults to the category, or to \"stop N\"."
},
"place": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "A specific place the driver already knows, as a coordinate. Use\nthis for \"the school\", \"the nursery\", \"Mum's\": places the map\ncannot be expected to resolve from the words alone. Resolve a NAMED\nplace with `geocode` first and pass the coordinate here; never\nguess one."
},
"category": {
"type": [
"string",
"null"
],
"description": "The KIND of place wanted: a category from `list_place_categories`\n(\"pharmacy\", \"fuel\", \"supermarket\"), or a colloquial phrase the\nserver normalises (\"petrol station\", \"chemist\"). Use this for\nanything the driver described by what it is rather than by name."
},
"dwell_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"description": "How long the driver is out of the car here, minutes (default 5)."
}
},
"description": "One errand in a `plan_errands` chain: a kind of place to find, or a\nplace the caller already knows."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"origin",
"destination",
"arrive_by",
"errands"
],
"properties": {
"origin": {
"$ref": "#/$defs/LatLon",
"description": "Where the driver sets off from."
},
"errands": {
"type": "array",
"items": {
"$ref": "#/$defs/ErrandSpec"
},
"description": "The errands, in any order: the answer decides the order. One to\nfive."
},
"arrive_by": {
"type": "string",
"description": "The hard arrival time, RFC 3339 with an offset\n(\"2026-09-21T15:15:00+01:00\"). Convert \"quarter past three\" to an\nabsolute instant in the driver's own offset before calling."
},
"depart_at": {
"type": [
"string",
"null"
],
"description": "When they set off, RFC 3339. Defaults to now."
},
"destination": {
"$ref": "#/$defs/LatLon",
"description": "Where they have to be by `arrive_by`."
},
"destination_name": {
"type": [
"string",
"null"
],
"description": "What to call the destination in the answer (\"the school\")."
},
"max_detour_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"description": "How far off the direct route a candidate place may sit, as a detour\nin minutes (default 12, at most 45)."
}
}
}| vehicle |
| any |
| The vehicle. Omitted ⇒ the published "saloon" default, and the answer says which vehicle it used. |
| start_soc | number | null | State of charge at the start, 0–1 (default 0.9). |
| waypoints | array | null | Intermediate points the route must pass through, in order (at most 8). Charge stops are inserted around them. |
| connectors | array | null | Keep only charge points offering at least one of these connector standards: "type2", "type1", "ccs", "chademo", "tesla", "domestic", "other". This narrows the vehicle's own set, never widens it. |
| destination* | any | Where it ends. |
| reserve_soc | number | null | The floor the state of charge must never fall below mid-route (default 0.1). Distinct from the arrival figure. |
| min_arrival_soc | number | null | Lowest acceptable state of charge on arrival (default 0.1). |
| max_detour_minutes | number | null | How far off the route a charge point may sit, as a detour in minutes (default 15, at most 120). |
| ambient_temperature_c | number | null | Ambient temperature in °C. Derates traction energy from a published study; cabin heating belongs in the vehicle's `aux_kw`. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"EvVehicleSpec": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "Display name for the vehicle in the answer."
},
"aux_kw": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Auxiliary load in kW, lights, electronics, cabin conditioning.\nWinter heating is several times the mild-weather default."
},
"mass_kg": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Kerb mass, kg."
},
"profile": {
"type": [
"string",
"null"
],
"description": "A published default profile: \"small_hatch\", \"saloon\", \"suv\" or\n\"van\". On its own it selects that vehicle; alongside any inline\nfigure below it is the base the figure overrides."
},
"connectors": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Connectors the vehicle accepts: \"type1\", \"type2\", \"ccs1\", \"ccs2\",\n\"chademo\", \"tesla\", \"gbt\"."
},
"battery_kwh": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross nominal battery capacity, kWh."
},
"drag_area_m2": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Drag area (drag coefficient × frontal area), m²."
},
"usable_fraction": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Fraction of the gross pack the vehicle will actually use, 0–1."
}
},
"description": "The vehicle for `plan_ev_route`: one of the published defaults by name,\ninline figures, or a named default with inline figures over it."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"origin",
"destination"
],
"properties": {
"min_kw": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Keep only charge points with a usable connector rated at least this\nmany kW (e.g. 50 for rapid charging only)."
},
"origin": {
"$ref": "#/$defs/LatLon",
"description": "Where the journey starts."
},
"vehicle": {
"anyOf": [
{
"$ref": "#/$defs/EvVehicleSpec"
},
{
"type": "null"
}
],
"description": "The vehicle. Omitted ⇒ the published \"saloon\" default, and the\nanswer says which vehicle it used."
},
"start_soc": {
"type": [
"number",
"null"
],
"format": "double",
"description": "State of charge at the start, 0–1 (default 0.9)."
},
"waypoints": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/LatLon"
},
"description": "Intermediate points the route must pass through, in order (at most\n8). Charge stops are inserted around them."
},
"connectors": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Keep only charge points offering at least one of these connector\nstandards: \"type2\", \"type1\", \"ccs\", \"chademo\", \"tesla\", \"domestic\",\n\"other\". This narrows the vehicle's own set, never widens it."
},
"destination": {
"$ref": "#/$defs/LatLon",
"description": "Where it ends."
},
"reserve_soc": {
"type": [
"number",
"null"
],
"format": "double",
"description": "The floor the state of charge must never fall below mid-route\n(default 0.1). Distinct from the arrival figure."
},
"min_arrival_soc": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Lowest acceptable state of charge on arrival (default 0.1)."
},
"max_detour_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"description": "How far off the route a charge point may sit, as a detour in\nminutes (default 15, at most 120)."
},
"ambient_temperature_c": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Ambient temperature in °C. Derates traction energy from a published\nstudy; cabin heating belongs in the vehicle's `aux_kw`."
}
}
}| Contour boundaries in minutes of travel time, e.g. [5, 10, 15] for 5/10/15-minute rings. 1 to 4 values (the routing engine's limit), each between 0 and 120 minutes. |
| exclude_polygons | array | null | Areas to avoid, scenario analysis ("close this bridge and recompute reachability"): an array of polygons, each an array of `[lon, lat]` pairs forming one exterior ring (GeoJSON-style, longitude FIRST). Roads intersecting any ring are excluded from the reachability search. Applies to the Valhalla engine; unsupported on the GraphHopper engine, where it is ignored. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"origin",
"contours_minutes"
],
"properties": {
"origin": {
"$ref": "#/$defs/LatLon",
"description": "Origin the reachable area is computed from."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Travel mode: \"auto\" (default), \"truck\", \"bicycle\", \"pedestrian\"\nor \"motor_scooter\"."
},
"polygons": {
"type": [
"boolean",
"null"
],
"description": "Return filled polygons instead of contour linestrings (default\nfalse). Polygons draw directly as a MapLibre fill layer."
},
"contours_minutes": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"description": "Contour boundaries in minutes of travel time, e.g. [5, 10, 15]\nfor 5/10/15-minute rings. 1 to 4 values (the routing engine's\nlimit), each between 0 and 120 minutes."
},
"exclude_polygons": {
"type": [
"array",
"null"
],
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2
}
},
"description": "Areas to avoid, scenario analysis (\"close this bridge and\nrecompute reachability\"): an array of polygons, each an array of\n`[lon, lat]` pairs forming one exterior ring (GeoJSON-style,\nlongitude FIRST). Roads intersecting any ring are excluded from\nthe reachability search. Applies to the Valhalla engine;\nunsupported on the GraphHopper engine, where it is ignored."
}
}
}| changes | any | Changes to the work itself. Optional, on the same condition. |
| costing | any | Costing model for the travel-time matrix: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| progress | array | Per-vehicle progress. Optional, but at least one progress entry or one change is required, a re-plan that reports nothing new is the original problem. |
| vehicles* | array | The fleet (at least one vehicle, each with a start and/or end). |
| emissions | any | The fleet's emission declaration, for UK clean-air / low-emission zone assessment. On its own it annotates: the response's `zones` block names every zone containing one of the problem's own locations and what this vehicle would pay there. With `avoid_zones` it also steers the internal travel-time matrix away from those zones, so the plan itself changes. |
| shipments | array | Pickup+delivery pairs. |
| avoid_zones | boolean | null | Keep the optimisation's travel-time matrix out of every zone the declared vehicle would be charged or banned in. Requires `emissions`. |
| territories | array | null | Fleet territories: named polygons that bound which vehicle may serve which stop, referenced by `vehicles[].territory_ids`. These are request data, caller-drawn rounds, validated per call and never stored. Nothing to do with clean-air zones or with the offline map packages of the same word. |
| relax_if_unassigned | any | Re-solve ONCE with these relaxations if the first solve leaves work unassigned, and say honestly which plan came back. At most one second solve, never beyond the caps you state, and the relaxed plan is returned only if it assigns MORE work than the first, giving away constraints for nothing is strictly worse than not giving them away. Breaks are never widened, nor are capacities, skills, territories or task caps: only time windows move, and only by the stated amounts. Bills as two solves when the second one runs. |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"RelaxSpec": {
"type": "object",
"properties": {
"allow_overtime_s": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Extend every vehicle's shift END by this many seconds. Shift starts\nare never moved earlier, a driver cannot begin before they begin."
},
"time_windows_by_s": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Widen every task time window by this many seconds at EACH end. A\n09:00–12:00 window with 1800 becomes 08:30–12:30."
}
},
"description": "What the caller is willing to give up if the first solve leaves work\nunassigned. At least one field is required."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
},
"ReloadsSpec": {
"type": "object",
"required": [
"max_trips"
],
"properties": {
"depot": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Where the vehicle reloads. Omitted, its own `start` is used (or its\n`end` if it declared only that)."
},
"max_trips": {
"type": "integer",
"format": "uint32",
"minimum": 0,
"description": "How many trips this vehicle may run in its shift, 2–5. A BUDGET,\nnot a prediction: the shift is cut into that many fixed windows\nbefore the solve, so asking for five trips on a shift that supports\nthree shrinks every window to a fifth and can make the whole day\nworse. Ask for the number of trips you actually expect to run."
},
"reload_time_s": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Seconds at the depot between trips, tipping, reloading, the\nweighbridge. Held out of the shift before it is partitioned, so it\nis never accidentally spent driving."
}
},
"description": "A vehicle's multi-trip reload plan."
},
"EmissionsFuel": {
"oneOf": [
{
"type": "string",
"const": "petrol",
"description": "Petrol, including petrol hybrids (schemes rate a hybrid by its\ncombustion engine's approval)."
},
{
"type": "string",
"const": "diesel",
"description": "Diesel, including diesel hybrids."
},
{
"type": "string",
"const": "electric",
"description": "Battery-electric."
},
{
"type": "string",
"const": "hydrogen",
"description": "Hydrogen fuel cell."
},
{
"type": "string",
"const": "gas",
"description": "LPG or CNG; rated as petrol by every scheme in the dataset."
}
],
"description": "What a vehicle burns, in clean-air-zone scheme terms."
},
"EmissionsSpec": {
"type": "object",
"required": [
"vehicle_category",
"fuel"
],
"properties": {
"fuel": {
"$ref": "#/$defs/EmissionsFuel",
"description": "What it burns."
},
"euro_standard": {
"type": [
"integer",
"null"
],
"format": "uint8",
"maximum": 255,
"minimum": 0,
"description": "Its Euro emission standard, 1–6. Heavy-duty approvals are written\nin Roman numerals (Euro VI); declare Euro VI as `6`. Required for\nany combustion fuel, without it no zone can be resolved, and a\nhalf-declared vehicle is indistinguishable from an undeclared one.\nOptional only for `electric` or `hydrogen`."
},
"vehicle_category": {
"$ref": "#/$defs/EmissionsVehicleCategory",
"description": "What kind of vehicle this is, in scheme terms."
}
},
"description": "A vehicle's emission declaration, for clean-air / low-emission zone\nassessment."
},
"TerritorySpec": {
"type": "object",
"required": [
"id",
"polygon"
],
"properties": {
"id": {
"type": "string",
"description": "Caller-chosen id, echoed back and referenced by\n`vehicles[].territory_ids`. Must be unique within the request."
},
"polygon": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2
},
"description": "The outer ring as GeoJSON `[lon, lat]` positions, longitude\nFIRST. Closed or open; an unclosed ring is closed for you."
}
},
"description": "One named territory: a polygon that bounds which vehicle may serve\nwhich stop."
},
"OptimiseJobSpec": {
"type": "object",
"required": [
"id",
"location"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "Caller-chosen job id, echoed back in steps and `unassigned`."
},
"pickup": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Quantities picked up at the job (matches vehicle `capacity`)."
},
"skills": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "uint32",
"minimum": 0
},
"description": "Skills the job requires."
},
"delivery": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Quantities delivered to the job (matches vehicle `capacity`)."
},
"location": {
"$ref": "#/$defs/LatLon",
"description": "Job location."
},
"service_s": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "On-site service time in seconds."
},
"time_windows": {
"type": [
"array",
"null"
],
"items": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"description": "Acceptable `[start, end]` windows in seconds."
}
},
"description": "One single-stop job of an optimisation problem."
},
"ReplanChangesSpec": {
"type": "object",
"properties": {
"add_jobs": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseJobSpec"
},
"description": "New single-stop jobs, in exactly the `optimise_routes` job shape."
},
"add_shipments": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseShipmentSpec"
},
"description": "New pickup+delivery pairs, in exactly the `optimise_routes`\nshipment shape."
},
"cancel_job_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "uint64",
"minimum": 0
},
"description": "Ids of jobs that no longer need doing. A job already reported\ncompleted cannot be cancelled; the response says so rather than\nsilently dropping it."
}
},
"description": "What has changed about the work since the plan was made."
},
"ReplanProgressSpec": {
"type": "object",
"required": [
"vehicle"
],
"properties": {
"vehicle": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "The vehicle this progress belongs to, an `id` from `vehicles`."
},
"unavailable": {
"type": [
"boolean",
"null"
],
"description": "The vehicle has dropped out of the shift, breakdown, illness, end\nof hours. It leaves the fleet for the re-plan; what it already\ncompleted stays completed."
},
"current_position": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Where the vehicle is now; becomes its start for the re-plan.\nOmitted, its last completed stop is used; with neither, its\noriginal start."
},
"completed_stop_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "uint64",
"minimum": 0
},
"description": "Ids of the stops this vehicle has already served, IN THE ORDER IT\nSERVED THEM. Each is a job id or a shipment pickup/delivery id.\nThis is the locked prefix: it already happened, so no re-plan may\nmove it."
}
},
"description": "One vehicle's progress through its shift."
},
"OptimiseVehicleSpec": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "Caller-chosen vehicle id, echoed back on its route."
},
"end": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "End location; omitted, the route ends at its last stop."
},
"start": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Start location; at least one of `start`/`end` is required."
},
"skills": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "uint32",
"minimum": 0
},
"description": "Skills this vehicle provides."
},
"reloads": {
"anyOf": [
{
"$ref": "#/$defs/ReloadsSpec"
},
{
"type": "null"
}
],
"description": "Let this vehicle return to a depot, reload and go out again, the\nwaste-collection tipping round, the van that comes back for a\nsecond wave of parcels."
},
"capacity": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Multidimensional capacity (same length as job `delivery`/`pickup`)."
},
"time_window": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Working window as `[start, end]` in seconds (any consistent epoch)."
},
"territory_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Ids of the request's `territories` this vehicle may work in.\nOmitted or empty, the vehicle is UNRESTRICTED and may serve any\ntask, inside a territory or outside every one of them. Listed, the\nvehicle may serve a task only if that task sits inside at least one\nof the named territories."
}
},
"description": "One vehicle of an optimisation fleet."
},
"OptimiseShipmentSpec": {
"type": "object",
"required": [
"pickup",
"delivery"
],
"properties": {
"amount": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "int64"
},
"description": "Quantities moved (matches vehicle `capacity`)."
},
"pickup": {
"$ref": "#/$defs/OptimiseShipmentStopSpec",
"description": "The pickup end."
},
"skills": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"format": "uint32",
"minimum": 0
},
"description": "Skills the shipment requires."
},
"delivery": {
"$ref": "#/$defs/OptimiseShipmentStopSpec",
"description": "The delivery end."
}
},
"description": "A pickup+delivery pair that must ride the same vehicle, pickup first."
},
"EmissionsVehicleCategory": {
"oneOf": [
{
"type": "string",
"const": "car",
"description": "A private car."
},
{
"type": "string",
"const": "van",
"description": "A van or light goods vehicle up to 3.5 tonnes."
},
{
"type": "string",
"const": "minibus",
"description": "A minibus (typically 8+ passenger seats, up to 5 tonnes)."
},
{
"type": "string",
"const": "hgv",
"description": "A heavy goods vehicle over 3.5 tonnes."
},
{
"type": "string",
"const": "bus",
"description": "A bus over 5 tonnes."
},
{
"type": "string",
"const": "coach",
"description": "A coach over 5 tonnes."
},
{
"type": "string",
"const": "taxi",
"description": "A licensed hackney carriage."
},
{
"type": "string",
"const": "phv",
"description": "A private hire vehicle."
},
{
"type": "string",
"const": "motorcycle",
"description": "A motorcycle, moped or tricycle."
},
{
"type": "string",
"const": "motorhome",
"description": "A motor caravan or campervan."
}
],
"description": "What a vehicle is, in clean-air-zone scheme terms.\n\nDeclaring this turns \"charge depends on vehicle emissions\" into an\nanswer. Without it a zone can only be named, never priced."
},
"OptimiseShipmentStopSpec": {
"type": "object",
"required": [
"id",
"location"
],
"properties": {
"id": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "Caller-chosen stop id, echoed back in steps and `unassigned`."
},
"location": {
"$ref": "#/$defs/LatLon",
"description": "Stop location."
},
"service_s": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "On-site service time in seconds."
}
},
"description": "One end (pickup or delivery) of a shipment."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"vehicles"
],
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseJobSpec"
},
"description": "Single-stop jobs (at least one job or shipment overall)."
},
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"; the travel-time matrix then respects dimensional and\ndangerous-goods restrictions, so the whole plan is truck-legal."
},
"changes": {
"anyOf": [
{
"$ref": "#/$defs/ReplanChangesSpec"
},
{
"type": "null"
}
],
"description": "Changes to the work itself. Optional, on the same condition."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model for the travel-time matrix: \"auto\" (default),\n\"truck\", \"bicycle\", \"pedestrian\" or \"motor_scooter\"."
},
"progress": {
"type": "array",
"items": {
"$ref": "#/$defs/ReplanProgressSpec"
},
"description": "Per-vehicle progress. Optional, but at least one progress entry or\none change is required, a re-plan that reports nothing new is the\noriginal problem."
},
"vehicles": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseVehicleSpec"
},
"description": "The fleet (at least one vehicle, each with a start and/or end)."
},
"emissions": {
"anyOf": [
{
"$ref": "#/$defs/EmissionsSpec"
},
{
"type": "null"
}
],
"description": "The fleet's emission declaration, for UK clean-air / low-emission\nzone assessment. On its own it annotates: the response's `zones`\nblock names every zone containing one of the problem's own\nlocations and what this vehicle would pay there. With\n`avoid_zones` it also steers the internal travel-time matrix away\nfrom those zones, so the plan itself changes."
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/$defs/OptimiseShipmentSpec"
},
"description": "Pickup+delivery pairs."
},
"avoid_zones": {
"type": [
"boolean",
"null"
],
"description": "Keep the optimisation's travel-time matrix out of every zone the\ndeclared vehicle would be charged or banned in. Requires\n`emissions`."
},
"territories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/TerritorySpec"
},
"description": "Fleet territories: named polygons that bound which vehicle may\nserve which stop, referenced by `vehicles[].territory_ids`. These\nare request data, caller-drawn rounds, validated per call and\nnever stored. Nothing to do with clean-air zones or with the\noffline map packages of the same word."
},
"relax_if_unassigned": {
"anyOf": [
{
"$ref": "#/$defs/RelaxSpec"
},
{
"type": "null"
}
],
"description": "Re-solve ONCE with these relaxations if the first solve leaves work\nunassigned, and say honestly which plan came back. At most one\nsecond solve, never beyond the caps you state, and the relaxed plan\nis returned only if it assigns MORE work than the first, giving\naway constraints for nothing is strictly worse than not giving them\naway. Breaks are never widened, nor are capacities, skills,\nterritories or task caps: only time windows move, and only by the\nstated amounts. Bills as two solves when the second one runs."
}
}
}| heading_deg | number | null | Which way the user is facing, in degrees **clockwise from true north** (0 = north, 90 = east, 180 = south, 270 = west). Supply it and every result is also described from the user's point of view ("just ahead on your right"); omit it and results fall back to cardinal directions ("to the north-east"), so the tool works with or without a compass. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum number of results (1–10, default 5). The hosted\nfirst-party index answers at most 5 nearest hits per lookup."
},
"fov_deg": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Field of view: the full width in degrees of a cone centred on\n`heading_deg`, outside which results are dropped, it is the\nFULL width, so 90 keeps only what lies within 45 degrees either\nside of dead ahead. Needs\n`heading_deg`, a cone has to point somewhere. The count of\nresults removed is reported as `out_of_view`."
},
"heading_deg": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Which way the user is facing, in degrees **clockwise from true\nnorth** (0 = north, 90 = east, 180 = south, 270 = west). Supply it\nand every result is also described from the user's point of view\n(\"just ahead on your right\"); omit it and results fall back to\ncardinal directions (\"to the north-east\"), so the tool works with\nor without a compass."
}
}
}| Argument | Type | Description |
|---|---|---|
| avoid | array | null | Road features to avoid as a PREFERENCE. Rendered as the costing's willingness factor set to zero, a thumb on the scale, not a ban. The engine's own reference is explicit that a value of zero is not guaranteed to avoid the feature entirely, and it does not: asking to avoid tolls across the Dartford Crossing returns the same tolled route, because the untolled alternative is fifty kilometres further. Use `exclude` when you mean a ban. |
| truck | any | Truck profile (dimensions + ADR declaration). Requires costing "truck"; when present, ADR dangerous-goods costing options are merged into the request. |
| origin* | any | Route origin. |
| scenic | boolean | null | Ask whether there is a prettier way (default false, `auto` costing only). The route in `geometry_polyline6` is NEVER swapped: what comes back is a peer offer beside it, in `scenic`, carrying the plain sentence that justifies it. No sentence, no offer: a route that scores well but cannot support one is dropped rather than dressed up, and `scenic.reason` is then null, which is an answer. Every candidate that lost says why in `scenic.rejections[]` (`same_route`, `no_scenic_gain`, `not_scenic_enough`, `over_time_budget`, `nothing_to_say`), so "no prettier way" is always attributable. Opt-in because it costs: at most two extra metered route computations, the same billing shape as `rationale`. Needs the MapMap gateway, whose basemap archive the scoring is measured against. |
| bicycle | any | Bicycle options (bicycle type, road/surface/hill preferences). Requires costing "bicycle". |
| costing | any | Costing model: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| exclude | array | null | Road features to exclude outright, rendered as the costing's hard exclusion flag. Two things follow from that and both matter: a hard exclusion can return NO ROUTE rather than a detour (excluding tunnels on a Rotherhithe crossing has no answer), and the flags depend on the routing engine's `allow_hard_exclusions` setting, which the engine does not expose and nothing here can read, so this is never promised, only requested. |
| emissions | any | The vehicle's emission declaration, for UK clean-air / low-emission zone assessment. Given, the response's `zones` block names every zone the route enters and what THIS vehicle pays there, with the publishing authority cited. Without it a zone can only be named, never priced. Needs the MapMap gateway, which holds the curated zone dataset; the full dataset is readable at `GET /v1/zones`. |
| landmarks | boolean | null | Name landmarks in the turn instructions (default false): each manoeuvre that passes a recognisable place, a petrol station, a supermarket, a household-name chain, gains a `landmark_instruction` like "Turn right just after the Shell garage" beside the engine's own street-name instruction, which is never replaced. Nothing is named unless it is recognisable from the road, within 40 m of the junction and not tagged as closed, so many routes come back with none: a wrong landmark is worse than no landmark. Needs the MapMap gateway, whose place index does the lookup. |
| rationale | boolean | null | Explain the route (default false): re-routes with each declared truck constraint (truck costing) or avoidance-side routing preference (auto, bicycle, pedestrian, motor_scooter) relaxed and reports the ones that actually changed the route as `rationale.avoided[]`. Opt-in, it costs up to 1 + N extra routing calls, one per declared field plus one combined probe, and it is billed for the ones it actually makes: at most 8 in total, typically fewer, and 1 when there is nothing to probe. Against the hosted gateway each probe is its own metered route call, which is exactly what `POST /route` with `rationale: true` charges for its own fan-out, so the two surfaces price the same explanation the same way. |
| waypoints | array | null | Optional intermediate stops, visited in order between origin and destination. |
| pedestrian | any | Pedestrian options (lit-street preference, wheelchair/blind type, hiking difficulty). Requires costing "pedestrian". |
| destination* | any | Route destination. |
| exclude_polygons | array | null | Areas to avoid, scenario analysis ("close this bridge and re-route"): an array of polygons, each an array of `[lon, lat]` pairs forming one exterior ring (GeoJSON-style, longitude FIRST). Roads intersecting any ring are excluded from the search. Applies to the Valhalla engine; unsupported on the GraphHopper engine, where it is ignored. |
{
"type": "object",
"$defs": {
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"BicycleSpec": {
"type": "object",
"properties": {
"use_hills": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Willingness to take hills, 0.0–1.0 (0.0 = avoid climbs even at the\ncost of longer routes)."
},
"use_roads": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Willingness to ride roads alongside motor traffic, 0.0–1.0\n(0.0 = prefer cycleways and quiet streets, the quiet-ride slider)."
},
"bicycle_type": {
"type": [
"string",
"null"
],
"description": "Bicycle type: \"road\", \"hybrid\" (default), \"city\", \"cross\" or\n\"mountain\". Sets default speed and surface tolerance."
},
"avoid_bad_surfaces": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Avoidance of surfaces unsuited to the bicycle type, 0.0–1.0\n(1.0 = strictly avoid bad surfaces)."
},
"use_living_streets": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Preference for living/shared streets, 0.0–1.0."
}
},
"description": "Bicycle options for costing \"bicycle\": the bicycle type plus road,\nsurface and hill preference weights, mapped onto Valhalla\n`costing_options.bicycle`."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
},
"AvoidFeature": {
"enum": [
"tolls",
"highways",
"ferries"
],
"type": "string",
"description": "A road feature to avoid as a PREFERENCE, not a ban. \"tolls\" and \"highways\" apply to motorised costings only (auto, truck, bus, motor_scooter, motorcycle); \"ferries\" applies to every costing. Asking for one on a costing whose engine table has no field for it is refused rather than silently ignored."
},
"EmissionsFuel": {
"oneOf": [
{
"type": "string",
"const": "petrol",
"description": "Petrol, including petrol hybrids (schemes rate a hybrid by its\ncombustion engine's approval)."
},
{
"type": "string",
"const": "diesel",
"description": "Diesel, including diesel hybrids."
},
{
"type": "string",
"const": "electric",
"description": "Battery-electric."
},
{
"type": "string",
"const": "hydrogen",
"description": "Hydrogen fuel cell."
},
{
"type": "string",
"const": "gas",
"description": "LPG or CNG; rated as petrol by every scheme in the dataset."
}
],
"description": "What a vehicle burns, in clean-air-zone scheme terms."
},
"EmissionsSpec": {
"type": "object",
"required": [
"vehicle_category",
"fuel"
],
"properties": {
"fuel": {
"$ref": "#/$defs/EmissionsFuel",
"description": "What it burns."
},
"euro_standard": {
"type": [
"integer",
"null"
],
"format": "uint8",
"maximum": 255,
"minimum": 0,
"description": "Its Euro emission standard, 1–6. Heavy-duty approvals are written\nin Roman numerals (Euro VI); declare Euro VI as `6`. Required for\nany combustion fuel, without it no zone can be resolved, and a\nhalf-declared vehicle is indistinguishable from an undeclared one.\nOptional only for `electric` or `hydrogen`."
},
"vehicle_category": {
"$ref": "#/$defs/EmissionsVehicleCategory",
"description": "What kind of vehicle this is, in scheme terms."
}
},
"description": "A vehicle's emission declaration, for clean-air / low-emission zone\nassessment."
},
"RouteLocation": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"properties": {
"preferred_side": {
"anyOf": [
{
"$ref": "#/$defs/PreferredSideKind"
},
{
"type": "null"
}
],
"description": "Which side of the street to arrive on (or depart from). `same` (or\n`curb`) puts the vehicle on the door's side of the road, resolved\nagainst the locale's driving side. Two honest limits: this is a\n**snapping preference**, not a manoeuvre guarantee, the engine\nprefers an edge on that side, it does not promise the driver never\ncrosses, and it needs a coordinate genuinely offset from the road\ncentreline, because a point on the centreline has no side."
},
"street_side_tolerance_m": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Metres: nearer than this to the road centreline, the side of street\nis treated as `none` and `preferred_side` does nothing. Engine\ndefault 5 m."
},
"street_side_max_distance_m": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Metres: further than this from the road centreline, the side of\nstreet is treated as `none` and `preferred_side` does nothing.\nEngine default 1000 m. Together with `street_side_tolerance_m` this\nis a WINDOW: a pair that leaves no window (tolerance at or above\nmax distance) is refused here rather than answered with a route on\nwhich the kerbside preference was silently inert."
}
},
"description": "One location of a `route` request: a coordinate, plus the optional\nkerbside approach for arriving at it.\n\nA bare `{lat, lon}` is still a complete location, every kerbside field\nis optional and omitting all of them is exactly the request that was\nmade before they existed."
},
"ExcludeFeature": {
"enum": [
"tolls",
"highways",
"ferries",
"bridges",
"tunnels"
],
"type": "string",
"description": "A road feature to exclude outright. A hard exclusion can leave a request with no path at all (that is the honest answer, not a failure) and it depends on the routing engine's own hard-exclusion setting, which nothing here can read."
},
"PedestrianSpec": {
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "Pedestrian type: \"wheelchair\" (avoids mapped steps and kerbs and\nthe rougher surface classes; hills per `use_hills`) or \"blind\"\n(richer guidance detail). Omit for the default on-foot profile."
},
"use_lit": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Preference for lit streets, 0.0–1.0 (1.0 = prefer lit paths as\nstrongly as possible, the \"walk me home on lit streets\" option).\nUnlit ways are still used when no lit alternative exists."
},
"use_hills": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Willingness to take hills, 0.0–1.0 (0.0 = avoid climbs as strongly\nas the engine can; the engine default is 0.5). A preference, not a\ncap. The MapMap gateway sends 0.0 on a wheelchair route that does\nnot set it, and reports that in `grade.preference`."
},
"max_grade_pct": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum grade in whole percent, 1–90. Needs the MapMap gateway:\nthe routing engine accepts this cap but does not enforce it yet,\nand the gateway's `grade.cap` says so on every route that sets it."
},
"surface_quality": {
"type": [
"string",
"null"
],
"description": "Surface quality for wheelchair routes: \"avoid\" (the default where\nthe deployment has a surface graph covering the route) or \"ignore\"\n(use the ordinary graph). Wheelchair only, and needs the MapMap\ngateway; the `surface_quality` block in the output says whether it\nwas applied."
},
"max_hiking_difficulty": {
"type": [
"integer",
"null"
],
"format": "uint8",
"maximum": 255,
"minimum": 0,
"description": "Maximum hiking-trail difficulty the route may use, as OSM\n`sac_scale` 1–6 (1 = well-cleared, mostly flat trails; 6 =\ndemanding alpine terrain). Default 1."
}
},
"description": "Pedestrian options for costing \"pedestrian\": lit-street preference,\npedestrian type, hills, surface quality and hiking difficulty, mapped\nonto Valhalla `costing_options.pedestrian` (surface quality and the\ngrade cap are MapMap gateway fields). All preferences, never\nguarantees: the router prefers matching ways where the map data\nsupports it."
},
"PreferredSideKind": {
"oneOf": [
{
"type": "string",
"const": "same",
"description": "The side the location itself projects to, the kerb, resolved\nagainst the locale's driving side (the left kerb in the UK, the\nright in Germany)."
},
{
"type": "string",
"const": "opposite",
"description": "The far side of the road from the location."
},
{
"type": "string",
"const": "either",
"description": "No side preference."
},
{
"type": "string",
"const": "curb",
"description": "Alias for `same`, from the OSRM/Mapbox `approaches` vocabulary."
},
{
"type": "string",
"const": "unrestricted",
"description": "Alias for `either`, from the OSRM/Mapbox `approaches` vocabulary."
}
],
"description": "Side-of-street preference for arriving at or departing from a location.\n\nCarries both vocabularies: MapMap's own `same`/`opposite`/`either` and\nthe OSRM/Mapbox `approaches` words `curb`/`unrestricted`, which are\naliases for `same` and `either`. Both spell the same request, on this\nsurface and on the HTTP API."
},
"EmissionsVehicleCategory": {
"oneOf": [
{
"type": "string",
"const": "car",
"description": "A private car."
},
{
"type": "string",
"const": "van",
"description": "A van or light goods vehicle up to 3.5 tonnes."
},
{
"type": "string",
"const": "minibus",
"description": "A minibus (typically 8+ passenger seats, up to 5 tonnes)."
},
{
"type": "string",
"const": "hgv",
"description": "A heavy goods vehicle over 3.5 tonnes."
},
{
"type": "string",
"const": "bus",
"description": "A bus over 5 tonnes."
},
{
"type": "string",
"const": "coach",
"description": "A coach over 5 tonnes."
},
{
"type": "string",
"const": "taxi",
"description": "A licensed hackney carriage."
},
{
"type": "string",
"const": "phv",
"description": "A private hire vehicle."
},
{
"type": "string",
"const": "motorcycle",
"description": "A motorcycle, moped or tricycle."
},
{
"type": "string",
"const": "motorhome",
"description": "A motor caravan or campervan."
}
],
"description": "What a vehicle is, in clean-air-zone scheme terms.\n\nDeclaring this turns \"charge depends on vehicle emissions\" into an\nanswer. Without it a zone can only be named, never priced."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"origin",
"destination"
],
"properties": {
"avoid": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AvoidFeature"
},
"description": "Road features to avoid as a PREFERENCE. Rendered as the costing's\nwillingness factor set to zero, a thumb on the scale, not a ban.\nThe engine's own reference is explicit that a value of zero is not\nguaranteed to avoid the feature entirely, and it does not: asking\nto avoid tolls across the Dartford Crossing returns the same tolled\nroute, because the untolled alternative is fifty kilometres\nfurther. Use `exclude` when you mean a ban."
},
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"; when present, ADR dangerous-goods costing options are\nmerged into the request."
},
"origin": {
"$ref": "#/$defs/RouteLocation",
"description": "Route origin."
},
"scenic": {
"type": [
"boolean",
"null"
],
"description": "Ask whether there is a prettier way (default false, `auto`\ncosting only). The route in `geometry_polyline6` is NEVER swapped:\nwhat comes back is a peer offer beside it, in `scenic`, carrying\nthe plain sentence that justifies it. No sentence, no offer: a\nroute that scores well but cannot support one is dropped rather\nthan dressed up, and `scenic.reason` is then null, which is an\nanswer. Every candidate that lost says why in\n`scenic.rejections[]` (`same_route`, `no_scenic_gain`,\n`not_scenic_enough`, `over_time_budget`, `nothing_to_say`), so\n\"no prettier way\" is always attributable. Opt-in because it\ncosts: at most two extra metered route computations, the same\nbilling shape as `rationale`. Needs the MapMap gateway, whose\nbasemap archive the scoring is measured against."
},
"bicycle": {
"anyOf": [
{
"$ref": "#/$defs/BicycleSpec"
},
{
"type": "null"
}
],
"description": "Bicycle options (bicycle type, road/surface/hill preferences).\nRequires costing \"bicycle\"."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model: \"auto\" (default), \"truck\", \"bicycle\", \"pedestrian\"\nor \"motor_scooter\"."
},
"exclude": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/ExcludeFeature"
},
"description": "Road features to exclude outright, rendered as the costing's hard\nexclusion flag. Two things follow from that and both matter: a hard\nexclusion can return NO ROUTE rather than a detour (excluding\ntunnels on a Rotherhithe crossing has no answer), and the flags\ndepend on the routing engine's `allow_hard_exclusions` setting,\nwhich the engine does not expose and nothing here can read, so\nthis is never promised, only requested."
},
"emissions": {
"anyOf": [
{
"$ref": "#/$defs/EmissionsSpec"
},
{
"type": "null"
}
],
"description": "The vehicle's emission declaration, for UK clean-air / low-emission\nzone assessment. Given, the response's `zones` block names every\nzone the route enters and what THIS vehicle pays there, with the\npublishing authority cited. Without it a zone can only be named,\nnever priced. Needs the MapMap gateway, which holds the curated\nzone dataset; the full dataset is readable at `GET /v1/zones`."
},
"landmarks": {
"type": [
"boolean",
"null"
],
"description": "Name landmarks in the turn instructions (default false): each\nmanoeuvre that passes a recognisable place, a petrol station, a\nsupermarket, a household-name chain, gains a\n`landmark_instruction` like \"Turn right just after the Shell\ngarage\" beside the engine's own street-name instruction, which is\nnever replaced. Nothing is named unless it is recognisable from the\nroad, within 40 m of the junction and not tagged as closed, so many\nroutes come back with none: a wrong landmark is worse than no\nlandmark. Needs the MapMap gateway, whose place index does the\nlookup."
},
"rationale": {
"type": [
"boolean",
"null"
],
"description": "Explain the route (default false): re-routes with each declared\ntruck constraint (truck costing) or avoidance-side routing\npreference (auto, bicycle, pedestrian, motor_scooter) relaxed and\nreports the ones that actually changed the route as\n`rationale.avoided[]`. Opt-in, it costs up to 1 + N extra routing\ncalls, one per declared field plus one combined probe, and it is\nbilled for the ones it actually makes: at most 8 in total,\ntypically fewer, and 1 when there is nothing to probe. Against the\nhosted gateway each probe is its own metered route call, which is\nexactly what `POST /route` with `rationale: true` charges for its\nown fan-out, so the two surfaces price the same explanation the\nsame way."
},
"waypoints": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/RouteLocation"
},
"description": "Optional intermediate stops, visited in order between origin and\ndestination."
},
"pedestrian": {
"anyOf": [
{
"$ref": "#/$defs/PedestrianSpec"
},
{
"type": "null"
}
],
"description": "Pedestrian options (lit-street preference, wheelchair/blind type,\nhiking difficulty). Requires costing \"pedestrian\"."
},
"destination": {
"$ref": "#/$defs/RouteLocation",
"description": "Route destination."
},
"exclude_polygons": {
"type": [
"array",
"null"
],
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2
}
},
"description": "Areas to avoid, scenario analysis (\"close this bridge and\nre-route\"): an array of polygons, each an array of `[lon, lat]`\npairs forming one exterior ring (GeoJSON-style, longitude FIRST).\nRoads intersecting any ring are excluded from the search. Applies\nto the Valhalla engine; unsupported on the GraphHopper engine,\nwhere it is ignored."
}
}
}| min_gap_m | number | null | Least distance along the route between two observations, metres (default 2000). A FLOOR, not a target: when the route holds more than `max_observations`, the gap widens past this on its own so the survivors stay spread over the whole journey. |
| max_observations | integer | null | Ceiling on how many observations come back, 1 to 200 (default 40). |
| geometry_polyline6* | string | The route shape, precision-6 encoded: `geometry_polyline6` straight out of the `route` tool's answer. Nothing else is accepted: there is no origin/destination form, because this tool annotates a route somebody already chose rather than computing one. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"geometry_polyline6"
],
"properties": {
"units": {
"type": [
"string",
"null"
],
"description": "Units for the spoken distances: `miles` (default) or\n`kilometers`. `kilometres` and `km` are accepted too."
},
"min_gap_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Least distance along the route between two observations, metres\n(default 2000). A FLOOR, not a target: when the route holds more\nthan `max_observations`, the gap widens past this on its own so\nthe survivors stay spread over the whole journey."
},
"max_observations": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Ceiling on how many observations come back, 1 to 200 (default\n40)."
},
"geometry_polyline6": {
"type": "string",
"description": "The route shape, precision-6 encoded: `geometry_polyline6`\nstraight out of the `route` tool's answer. Nothing else is\naccepted: there is no origin/destination form, because this tool\nannotates a route somebody already chose rather than computing\none."
}
}
}| any |
| Costing model for the route and detour matrix: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
| category | string | null | Explicit place category ("fuel", "cafe", "charging_station", same vocabulary as nearby_places). Colloquial phrases are normalised server-side; prefer this over query for category intents. |
| destination | any | Route destination. |
| max_results | integer | null | Maximum results (default 5, at most 25). |
| geometry_polyline6 | string | null | An existing route geometry as an encoded polyline6 (the `route` tool's `geometry_polyline6`). Provide either this or `origin` + `destination`, not both. |
| max_detour_minutes | number | null | Largest acceptable detour in minutes (default 10, at most 120). |
{
"type": "object",
"$defs": {
"LatLon": {
"anyOf": [
{
"type": "object",
"required": [
"lat",
"lon"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Latitude in decimal degrees (−90 to 90)."
},
"lon": {
"type": "number",
"format": "double",
"description": "Longitude in decimal degrees (−180 to 180)."
}
}
},
{
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 2,
"minItems": 2,
"description": "GeoJSON position [lon, lat]: longitude FIRST."
}
],
"description": "A WGS84 coordinate in decimal degrees: a {lat, lon} object (preferred), or a GeoJSON [lon, lat] array with LONGITUDE FIRST, the same order as every polygon field on this server."
},
"TruckSpec": {
"type": "object",
"properties": {
"hazmat": {
"type": "boolean",
"default": false,
"description": "Whether the vehicle carries dangerous goods (ADR). Defaults to\nfalse."
},
"width_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle width in metres."
},
"height_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle height in metres."
},
"length_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Vehicle length in metres."
},
"tunnel_code": {
"type": [
"string",
"null"
],
"description": "ADR 8.6.4 tunnel restriction code of the load, e.g. \"B\", \"C5000D\",\n\"B/D\", or \"(-)\"/\"none\" for explicitly unrestricted. Leave unset if\nunknown: a hazmat load without a code is conservatively treated as\ncode B (allowed only through category-A tunnels)."
},
"gross_weight_t": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Gross combination weight in metric tonnes."
}
},
"description": "Truck profile for routing: physical dimensions plus the ADR\ndangerous-goods declaration. Omitted dimensions default to the EU\nmaximum authorised dimensions of Council Directive 96/53/EC (4.0 m\nheight, 2.55 m width, 16.5 m length, 40 t gross weight)."
},
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"description": "Free-text POI query, e.g. \"coffee\", \"EV charger\", \"truck stop\"."
},
"truck": {
"anyOf": [
{
"$ref": "#/$defs/TruckSpec"
},
{
"type": "null"
}
],
"description": "Truck profile (dimensions + ADR declaration). Requires costing\n\"truck\"; the detours then respect dimensional/ADR restrictions."
},
"origin": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Route origin (with `destination`, when no geometry is given)."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing model for the route and detour matrix: \"auto\" (default),\n\"truck\", \"bicycle\", \"pedestrian\" or \"motor_scooter\"."
},
"category": {
"type": [
"string",
"null"
],
"description": "Explicit place category (\"fuel\", \"cafe\", \"charging_station\", same\nvocabulary as nearby_places). Colloquial phrases are normalised\nserver-side; prefer this over query for category intents."
},
"destination": {
"anyOf": [
{
"$ref": "#/$defs/LatLon"
},
{
"type": "null"
}
],
"description": "Route destination."
},
"max_results": {
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0,
"description": "Maximum results (default 5, at most 25)."
},
"geometry_polyline6": {
"type": [
"string",
"null"
],
"description": "An existing route geometry as an encoded polyline6 (the `route`\ntool's `geometry_polyline6`). Provide either this or `origin` +\n`destination`, not both."
},
"max_detour_minutes": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Largest acceptable detour in minutes (default 10, at most 120)."
}
},
"additionalProperties": false
}{
"type": "object",
"$defs": {
"Direction": {
"oneOf": [
{
"type": "string",
"const": "forward",
"description": "Along the way's node order."
},
{
"type": "string",
"const": "backward",
"description": "Against it."
},
{
"type": "string",
"const": "both",
"description": "Both carriageways."
}
],
"description": "Carriageway of a way, spelled as the artefact spells it. A serde\ntwin of [`WayDirection`], which deliberately carries no serde."
},
"ClosureAssertion": {
"oneOf": [
{
"type": "object",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"const": "closed"
}
},
"description": "Hard exclusion."
},
{
"type": "object",
"required": [
"kind",
"speed_kph"
],
"properties": {
"kind": {
"type": "string",
"const": "speed_override"
},
"speed_kph": {
"type": "integer",
"format": "uint32",
"minimum": 0,
"description": "The speed."
}
},
"description": "A speed, km/h."
}
],
"description": "What a temporary closure asserts."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"way_ids",
"assert",
"ttl_secs",
"reason"
],
"properties": {
"assert": {
"$ref": "#/$defs/ClosureAssertion",
"description": "`closed` or a speed in km/h (1..=120)."
},
"reason": {
"type": "string",
"description": "Why, for the audit log and the incidents endpoint note."
},
"way_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "uint64",
"minimum": 0
},
"description": "OSM way ids to assert on; at most 20."
},
"ttl_secs": {
"type": "integer",
"format": "uint64",
"minimum": 0,
"description": "Lifetime, seconds, 60..=86400."
},
"direction": {
"$ref": "#/$defs/Direction",
"default": "both",
"description": "Carriageway, default `both`."
},
"evidence_url": {
"type": [
"string",
"null"
],
"description": "Evidence link, if any."
}
}
}| string | null |
| MapMap SDK version integrated against, when known (at most 50 bytes). |
{
"type": "object",
"$defs": {
"RetroProblemArea": {
"oneOf": [
{
"type": "string",
"const": "sdk",
"description": "The mobile/web SDKs."
},
{
"type": "string",
"const": "api",
"description": "The hosted HTTP API."
},
{
"type": "string",
"const": "mcp",
"description": "The MCP tool surface."
},
{
"type": "string",
"const": "docs",
"description": "Documentation."
},
{
"type": "string",
"const": "billing",
"description": "Billing, keys or quotas."
},
{
"type": "string",
"const": "self-host",
"description": "Self-hosted deployment."
},
{
"type": "string",
"const": "other",
"description": "Anything else."
}
],
"description": "The platform area an integration problem belongs to (mirrors the\ngateway's `POST /v1/feedback` schema)."
},
"RetroProblemInput": {
"type": "object",
"required": [
"area",
"description",
"workaround_found"
],
"properties": {
"area": {
"$ref": "#/$defs/RetroProblemArea",
"description": "Which part of the platform the problem was in."
},
"description": {
"type": "string",
"description": "What went wrong (at most 1000 bytes)."
},
"workaround_found": {
"type": "boolean",
"description": "Whether a workaround was found."
}
},
"description": "One problem hit during the integration."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"what_built"
],
"properties": {
"wins": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "What went well (at most 20 entries × 500 bytes)."
},
"gotchas": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Surprises/traps worth documenting (at most 20 entries × 500 bytes)."
},
"problems": {
"type": "array",
"items": {
"$ref": "#/$defs/RetroProblemInput"
},
"default": [],
"description": "Problems hit during the integration (at most 20)."
},
"docs_gaps": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Documentation gaps hit (at most 20 entries × 500 bytes)."
},
"agent_name": {
"type": [
"string",
"null"
],
"description": "The submitting agent's name, e.g. \"Claude Code\" (at most 100\nbytes)."
},
"what_built": {
"type": "string",
"description": "What was built with MapMap, in one or two sentences (required, at\nmost 500 bytes)."
},
"sdk_version": {
"type": [
"string",
"null"
],
"description": "MapMap SDK version integrated against, when known (at most 50\nbytes)."
}
}
}| webhook_url | string | null | Optional HTTPS URL to POST a signed `{job_id, kind, status, result_url}` notification to when the job finishes. The RESULT is never pushed, the notification says where to fetch it. Requires a webhook signing secret on the key; without one the submission is refused rather than delivered unsigned. An agent that can poll does not need this: polling with `get_job` is free. |
{
"type": "object",
"$defs": {
"JobKind": {
"oneOf": [
{
"type": "string",
"const": "optimise",
"description": "A fleet optimisation, the `optimise_routes` problem, at ten times\nthe synchronous location cap."
},
{
"type": "string",
"const": "replan",
"description": "A mid-shift re-plan, the `replan_routes` problem, counted on the\nremaining work."
},
{
"type": "string",
"const": "matrix",
"description": "A many-to-many time/distance matrix, the `matrix` problem, at four\ntimes the synchronous element cap."
}
],
"description": "Which asynchronous problem is being submitted."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"kind",
"problem"
],
"properties": {
"kind": {
"$ref": "#/$defs/JobKind",
"description": "Which problem this is. It selects both the body shape below and the\nceiling the submission is judged against."
},
"problem": {
"description": "The problem itself, in exactly the shape the synchronous tool takes\n, `optimise_routes` input for `optimise`, `replan_routes` input for\n`replan`, `matrix` input for `matrix`. Moving a working synchronous\ncall onto this lane changes nothing but the tool you call it with."
},
"webhook_url": {
"type": [
"string",
"null"
],
"description": "Optional HTTPS URL to POST a signed `{job_id, kind, status,\nresult_url}` notification to when the job finishes. The RESULT is\nnever pushed, the notification says where to fetch it. Requires a\nwebhook signing secret on the key; without one the submission is\nrefused rather than delivered unsigned. An agent that can poll does\nnot need this: polling with `get_job` is free."
}
}
}| any |
| Costing for feasibility legs: "auto" (default), "truck", "bicycle", "pedestrian" or "motor_scooter". |
{
"type": "object",
"$defs": {
"CostingKind": {
"oneOf": [
{
"type": "string",
"const": "auto",
"description": "Standard car costing."
},
{
"type": "string",
"const": "truck",
"description": "Truck costing; honours dimensional limits and, when a `truck`\nprofile is supplied, ADR dangerous-goods restrictions."
},
{
"type": "string",
"const": "bicycle",
"description": "Bicycle costing; tune it with a `bicycle` options object."
},
{
"type": "string",
"const": "pedestrian",
"description": "Pedestrian (walking) costing; tune it with a `pedestrian` options\nobject (lit streets, wheelchair/blind, hiking difficulty)."
},
{
"type": "string",
"const": "motor_scooter",
"description": "Motor scooter (moped) costing: like auto but prefers lower-speed\nroads and may use ways closed to larger motor vehicles."
}
],
"description": "Costing models exposed by the MCP tools (a deliberate subset of the\nValhalla costing list), serialised in snake_case exactly as Valhalla\nnames them."
},
"VerifyClaimInput": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "Caller-chosen id, echoed back on the matching result. Auto-assigned\n(\"claim-1\", …) when omitted."
},
"name": {
"type": "string",
"description": "The place name as claimed, e.g. \"The Eagle and Child\"."
},
"locality": {
"type": [
"string",
"null"
],
"description": "Optional disambiguating context, e.g. \"Oxford\". Country-level words\n(\"UK\", \"England\", …) are stripped before querying, they add noise,\nnot signal, to name search."
},
"sequence": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Itinerary position. Claims that share increasing `sequence` values\nand both carry `claimed_time` form legs the feasibility pass checks."
},
"claimed_time": {
"type": [
"string",
"null"
],
"description": "ISO 8601 timestamp: when the itinerary claims you are at this place."
}
},
"description": "One place claim for the `verify_places` tool: a place an AI mentioned,\nto be checked for existence and (as part of an itinerary) feasibility.\n\nUnknown fields are refused, naming the accepted ones. A dev-lane run\n(19 Oct 2026) passed `near` instead of `locality`; it was silently\ndropped, \"Roman Baths\" matched Ankara, and the itinerary leg became\nuncomputable with nothing telling the caller why.",
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "Free text to extract place claims from (best-effort heuristic:\nquoted phrases and Title Case runs after \"at/in/near/to/from/\nvisiting\", not NLP or an LLM call, and it does not attempt\nitinerary feasibility since there are no explicit times to anchor\nlegs to). Mutually exclusive with `claims`. Max 8,000 characters."
},
"claims": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/VerifyClaimInput"
},
"description": "Structured claims, the reliable path, and the only path that\nsupports itinerary feasibility. Mutually exclusive with `text`.\nMax 20 per request."
},
"costing": {
"$ref": "#/$defs/CostingKind",
"default": "auto",
"description": "Costing for feasibility legs: \"auto\" (default), \"truck\", \"bicycle\",\n\"pedestrian\" or \"motor_scooter\"."
}
},
"additionalProperties": false
}| sample_interval_m | number | null | Distance between samples in metres (default 25,000, clamped to 5,000 to 100,000; at most 40 samples per route). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"shape"
],
"properties": {
"shape": {
"type": "string",
"description": "The route shape as an encoded polyline6 (the `route` tool's\n`geometry_polyline6`)."
},
"depart_at": {
"type": [
"string",
"null"
],
"description": "Departure time, RFC 3339 (e.g. \"2026-10-12T14:00:00Z\"); defaults to\nnow. Forecasts reach about 16 days ahead; samples past that answer\nunavailable."
},
"duration_s": {
"type": [
"number",
"null"
],
"format": "double",
"description": "The route's duration in seconds, used to work out when you reach\neach sample. Pass the `route` tool's duration; omitted, a generic\n80 km/h average is assumed and `duration_source` says so."
},
"sample_interval_m": {
"type": [
"number",
"null"
],
"format": "double",
"description": "Distance between samples in metres (default 25,000, clamped to\n5,000 to 100,000; at most 40 samples per route)."
}
}
}