Skip to main content
Glama

geocode_structured

Read-onlyIdempotent

Geocode from discrete address components (address, locality, region, postalcode, country) instead of one free-text string. Use when the input is already fielded (forms, CRM records, stop tables) — skips free-text parsing so components can't be mis-tokenized. At least one component is required. No cross-street field: for named intersections use resolve_intersection or geocode.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sizeNoNumber of candidates to return (default 5, max 40)
regionNoState / province — full name or abbreviation (e.g. 'TX')
addressNoStreet address — house number + street name (e.g. '1600 Pennsylvania Ave NW')
countryNoISO 3166-1 alpha-2/alpha-3 country code (full names also resolve)
localityNoCity / town name
focus_latNoBias results near this latitude
focus_lonNoBias results near this longitude
postalcodeNoPostal / ZIP code
boundary_countryNoScope results to this ISO country code — wins over `country` for boundary filtering

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsNo
geojsonNo
metricsNo
summaryNoMap of scalar facts the LLM should surface verbatim
precisionNo
display_hintNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / items / items / properties / postal_code / description
      Previous value: -"An eligible US ZIP5 normalized from the selected native result's available postal-code field; direct address-record origin is not yet guaranteed. Not checked against any postal operator's records, so a syntactically correct value can still be wrong for the address. Omitted when unavailable or unsuitable for five-digit form. US address results only. Distinct from `address_evidence.postal_code`, which is a presence STATUS rather than a value. On reverse geocoding this describes the RETURNED ADDRESS — it is not a postal assignment to the coordinate you supplied."New value: +"An eligible US ZIP5 read from the selected result's own postal-code field. While origin enforcement is active this field is emitted ONLY when the engine stamped the value as coming from the address record itself (`source_record` provenance); a value inherited from a parent area, or a result cached before that evidence existed, is omitted rather than emitted without provenance — so an absent ZIP under enforcement means \"not proven for this record\", not \"no such ZIP\". Provenance describes only WHERE the value came from. It is not a postal operator check of any kind — no certification, no address-quality rating, and no statement about whether mail would arrive — so a syntactically correct, correctly-sourced value can still be wrong for the address. Also omitted when unavailable or unsuitable for five-digit form. US address results only. Distinct from `address_evidence.postal_code`, which is a presence STATUS rather than a value. On reverse geocoding this describes the RETURNED ADDRESS — it is not a postal assignment to the coordinate you supplied."
  2. Changed2 schema fields changed
    • addedOutput schema / properties / items / items / properties / address_components / properties / region_name
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / items / items / properties / postal_input_match
      Added value: +{
      +  "description": "STRUCTURED GEOCODING ONLY (`geocode_structured` / `POST /v1/search/structured`); absent from free-text geocoding. Whether the postcode YOU SUBMITTED agrees with this candidate's own postcode — `match` (same five-digit value), `conflict` (they differ), `unavailable` (no comparison was possible). This compares two values already in hand: no lookup, no external reference, and your query text is never parsed to find one. `conflict` does NOT say which side is wrong — your input may name a neighbouring area, the candidate may be a near-miss, or the record's own value may be stale; treat it as a prompt to ask a human, never as a correction to apply automatically. The candidate side counts only when its postcode came from the address record itself; one inherited from a parent area yields `unavailable` rather than a misleading verdict. `unavailable` also covers: nothing submitted, a submitted value not readable as a US five-digit code, and results cached before this field existed.",
      +  "enum": [
      +    "match",
      +    "conflict",
      +    "unavailable"
      +  ],
      +  "type": "string"
      +}
  3. Changed5 schema fields changed
    • addedOutput schema / properties / items / items / properties / address_components
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "The same US components the formatted string is built from. Every field is source-established or absent; nothing is inferred or back-filled.",
      +  "properties": {
      +    "country_code": {
      +      "type": "string"
      +    },
      +    "house_number": {
      +      "type": "string"
      +    },
      +    "locality": {
      +      "type": "string"
      +    },
      +    "postal_code": {
      +      "type": "string"
      +    },
      +    "region_code": {
      +      "type": "string"
      +    },
      +    "street": {
      +      "type": "string"
      +    },
      +    "unit": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / properties / items / items / properties / address_line1
      Added value: +{
      +  "description": "House number and street for an eligible US address result, composed from the result's own components — never parsed from the display label. Absent when the result is not a US street address.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / items / items / properties / address_line2
      Added value: +{
      +  "description": "Unit or suite, only when the source record carries one. A unit supplied in your request is never echoed back here.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / items / items / properties / formatted_address
      Added value: +{
      +  "description": "Single-line US display form, e.g. `1600 Pennsylvania Avenue NW, Washington, DC 20500, USA`. The postal segment is present only when an eligible ZIP is; its absence never suppresses the street address.",
      +  "type": "string"
      +}
    • changedOutput schema / properties / items / items / properties / postal_code / description
      Previous value: -"Five-digit ZIP taken from the postcode supplied with this address record. It is reported by that record's own data source and has not been checked against any postal operator's records, so a syntactically correct value can still be wrong for the address. Omitted when unavailable or unsuitable for five-digit form. US address results only. Distinct from `address_evidence.postal_code`, which is a presence STATUS rather than a value. On reverse geocoding this describes the RETURNED ADDRESS — it is not a postal assignment to the coordinate you supplied."New value: +"An eligible US ZIP5 normalized from the selected native result's available postal-code field; direct address-record origin is not yet guaranteed. Not checked against any postal operator's records, so a syntactically correct value can still be wrong for the address. Omitted when unavailable or unsuitable for five-digit form. US address results only. Distinct from `address_evidence.postal_code`, which is a presence STATUS rather than a value. On reverse geocoding this describes the RETURNED ADDRESS — it is not a postal assignment to the coordinate you supplied."
  4. Changed1 schema field changed
    • addedOutput schema / properties / items / items / properties / postal_code
      Added value: +{
      +  "description": "Five-digit ZIP taken from the postcode supplied with this address record. It is reported by that record's own data source and has not been checked against any postal operator's records, so a syntactically correct value can still be wrong for the address. Omitted when unavailable or unsuitable for five-digit form. US address results only. Distinct from `address_evidence.postal_code`, which is a presence STATUS rather than a value. On reverse geocoding this describes the RETURNED ADDRESS — it is not a postal assignment to the coordinate you supplied.",
      +  "pattern": "^[0-9]{5}$",
      +  "type": "string"
      +}
  5. Changed2 schema fields changed
    • addedOutput schema / properties / items / items / properties / address_evidence
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "What THIS CANDIDATE carries, component by component — `matched` (a real value is present), `partial` (only a coarser or derived stand-in, e.g. an interpolated house number or a locality falling back to its administrative parent), `absent` (nothing). This describes the result, NOT a comparison against your query: the engine returns no per-component match data, and re-parsing your text here would mean two parsers disagreeing about the same string. Derived from the feature, never from `confidence`.",
      +  "properties": {
      +    "house_number": {
      +      "enum": [
      +        "matched",
      +        "partial",
      +        "absent"
      +      ],
      +      "type": "string"
      +    },
      +    "locality": {
      +      "$ref": "#/properties/items/items/properties/address_evidence/properties/house_number"
      +    },
      +    "postal_code": {
      +      "description": "Whether the candidate carries a postal code. Presence only — this states what the result has, and makes no claim about its correctness.",
      +      "enum": [
      +        "matched",
      +        "partial",
      +        "absent"
      +      ],
      +      "type": "string"
      +    },
      +    "region": {
      +      "$ref": "#/properties/items/items/properties/address_evidence/properties/house_number"
      +    },
      +    "street": {
      +      "$ref": "#/properties/items/items/properties/address_evidence/properties/house_number"
      +    }
      +  },
      +  "required": [
      +    "house_number",
      +    "street",
      +    "locality",
      +    "region",
      +    "postal_code"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / items / items / properties / confidence_scope
      Added value: +{
      +  "const": "query_to_candidate",
      +  "description": "What `confidence` is scoped to. `query_to_candidate` means it scores how well this candidate matches the submitted query — it is NOT a probability that the place is real, that the address is correct, or that mail would arrive. Fixed value today; treat it as a closed set that may gain members.",
      +  "type": "string"
      +}
  6. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, openWorld and idempotent, so safety is covered. The description adds non-obvious behavioral facts: that free-text parsing is skipped (so components can't be mis-tokenized), that at least one component is required despite required=0 in the schema, and that there is no cross-street field. It stops short of describing the candidate set or ordering, but the added context is substantial.

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

Conciseness5/5

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

Three tight sentences: the differentiator is front-loaded, the usage trigger comes second, and the exclusion/alternative routing comes last. No filler and nothing repeated from the schema or annotations.

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

Completeness5/5

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

An output schema exists, so return values need not be explained. Given a 9-parameter, fully documented schema plus safety annotations, the description supplies exactly the extra context an agent needs — the input-shape constraint, the minimum-component requirement, and the missing cross-street capability.

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

Parameters3/5

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

Schema description coverage is 100%, so every parameter including size, focus_lat/lon and boundary_country is already documented in the schema; the baseline is 3. The description enumerates the component fields but adds no syntax or precedence guidance beyond the schema (e.g. boundary_country winning over country is left to the schema text).

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

Purpose5/5

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

States a specific verb (Geocode) and the distinctive resource/input mode (discrete address components vs. one free-text string), and immediately distinguishes itself from geocode and resolve_intersection. An agent can tell this apart from its siblings without opening a schema.

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

Usage Guidelines5/5

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

Explicitly says when to use it ('input is already fielded (forms, CRM records, stop tables)') and names the alternatives for the excluded case ('for named intersections use resolve_intersection or geocode'). Both routing conditions are stated, not inferred.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources