Skip to main content
Glama
Sign In

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Geocode · Suburb autocomplete

geocode_suburb
Read-onlyIdempotent

Autocomplete a partial suburb search string against the official suburb (SAL) list. Use this before calling /v1/suburbs/{name}/... — those endpoints require a canonical SAL name in the path.

Free.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "q": "<q>"
    },
    "name": "geocode_suburb"
  }
}

Input Schema

NameRequiredDescriptionDefault
qYesPartial suburb name.
stateNoOptional state (NSW, VIC, ...). It ranks that state's matches first; it does not exclude other states.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / state / description
      Previous value: -"Optional state filter (NSW, VIC, ...)."New value: +"Optional state (NSW, VIC, ...). It ranks that state's matches first; it does not exclude other states."
  2. Changed1 schema field changed
    • changedOutput 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: +null
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive and closed-world behavior, so the safety bar is covered. The description adds real context: results are canonical SAL names and the call is free (no quota cost), which the annotations do not convey.

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?

Two sentences, front-loaded with the action and followed by the reason to call it; the bolded 'Free.' cost note is a single word that earns its place.

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

Completeness4/5

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

For a simple two-parameter lookup with full schema coverage and rich annotations, the description supplies purpose, sequencing, and cost. The only gap is that it does not say what a match list looks like (no output schema exists), which is minor here.

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 coverage is 100% and the schema already explains that q is a partial name and that state only ranks matches rather than filtering them. The description adds no parameter-level meaning beyond that, so the baseline 3 is correct.

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

Purpose4/5

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

States a specific verb and resource: autocompleting a partial suburb string against the official SAL list, and clarifies the output is a canonical SAL name. It separates itself from address geocoding by scope, though it never names the sibling geocode_address directly.

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

Usage Guidelines4/5

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

Gives an explicit upstream condition: call this before hitting /v1/suburbs/{name}/... because those need a canonical SAL name. That is strong positive guidance, but there is no statement of when not to use it (e.g. when a full address is already known).

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

All Microburbs Australian Property Data toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources