geocode_suburbAutocomplete a partial suburb search string against the ABS SAL
list. Use this before calling /v1/suburbs/{name}/... — those
endpoints require a canonical SAL name in the path.
Free.
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | Partial suburb name. | |
| state | No | Optional state filter (NSW, VIC, ...). |
Changes observed during successful MCP inspections.
Output schema / (root)Previous value: -{
- "properties": {
- "available": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "description": "`false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator.",
- "title": "Available"
- },
- "data": {
- "anyOf": [
- {
- "items": {
- "additionalProperties": true,
- "description": "One candidate row returned by the suburb autocomplete.\n\nOpen shape — see GnafCandidate. The helper returns\n``area_name`` / ``area_level`` / ``information`` (a nested chain of\nPOA / SA2 / SA3 / SA4 / LGA / state).",
- "example": {
- "area_level": "suburb",
- "area_name": "Belmont (NSW)",
- "information": {
- "lga": "Lake Macquarie",
- "poa": "2280",
- "sa2": "Belmont - Bennetts Green",
- "sa3": "Lake Macquarie - East",
- "sa4": "Newcastle and Lake Macquarie",
- "state": "New South Wales"
- }
- },
- "properties": {},
- "title": "SuburbCandidate",
- "type": "object"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "description": "The endpoint's payload, or `null` when Microburbs has no value.",
- "title": "Data"
- },
- "message": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Human-readable explanation. Omitted on success.",
- "title": "Message"
- },
- "reason": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success.",
- "title": "Reason"
- }
- },
- "title": "ApiResponse[list[SuburbCandidate]]",
- "type": "object",
- "x-fastmcp-top-level-schema": "ApiResponse_list_SuburbCandidate__"
-}New value: +nullDoes the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnly, idempotent, non-destructive. The description adds the free cost detail which is valuable and not in annotations. It also mentions the requirement to obtain canonical SAL names, which is behavioral context about the output's purpose.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Very concise, two short paragraphs plus a bold 'Free.' The key usage context is front-loaded. Every sentence adds value - the autocomplete purpose, the prerequisite note, and the free cost indicator.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For an autocomplete tool with simple parameters and no output schema, the description is complete. It explains why the tool exists (for canonical names), when to use it, and the cost. Nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are well-documented. The description doesn't add much beyond that, but it reinforces the 'partial' nature of the q parameter which aligns with schema. No extra syntax needed, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it autocompletes a partial suburb search string against the ABS SAL list - specific verb and resource. It also distinguishes itself from the sibling geocode_address by focusing on suburb names. It even references the subsequent use of /v1/suburbs/{name}/... endpoints.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells when to use: before calling /v1/suburbs/{name}/... endpoints that require canonical SAL names. Also notes it's free, implying no cost considerations. It implicitly distinguishes from geocode_address which likely handles addresses.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.