Skip to main content
Glama

Microburbs Australian Property Data

Suburb · Geography profile

suburbs_profile
Read-onlyIdempotent

The suburb's upward geography chain — LGA, SA2/3/4, GCCSA, state, postcode. Use /v1/suburbs/list to discover canonical SAL names (and filter by state / LGA / SA4 / postcode).

Price: 3¢ per call.

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": {
      "suburb_name": "<suburb_name>"
    },
    "name": "suburbs_profile"
  }
}

Input Schema

NameRequiredDescriptionDefault
suburb_nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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": [
      -        {
      -          "description": "ABS geo profile — the upward admin chain for a suburb.",
      -          "example": {
      -            "gccsa": "Rest of NSW",
      -            "lga": "Lake Macquarie",
      -            "postcode": "2280",
      -            "sa2": "Belmont - Bennetts Green",
      -            "sa3": "Lake Macquarie - East",
      -            "sa4": "Newcastle and Lake Macquarie",
      -            "state": "New South Wales",
      -            "suburb": "Belmont North"
      -          },
      -          "properties": {
      -            "gccsa": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Greater Capital City Statistical Area.",
      -              "title": "Gccsa"
      -            },
      -            "lga": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Local Government Area.",
      -              "title": "Lga"
      -            },
      -            "postcode": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Postcode (POA).",
      -              "title": "Postcode"
      -            },
      -            "sa2": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "SA2 name.",
      -              "title": "Sa2"
      -            },
      -            "sa3": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "SA3 name.",
      -              "title": "Sa3"
      -            },
      -            "sa4": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "SA4 name.",
      -              "title": "Sa4"
      -            },
      -            "state": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "State / Territory.",
      -              "title": "State"
      -            },
      -            "suburb": {
      -              "description": "Suburb (SAL — ABS Suburb and Locality).",
      -              "title": "Suburb",
      -              "type": "string"
      -            }
      -          },
      -          "required": [
      -            "suburb"
      -          ],
      -          "title": "SuburbProfile",
      -          "type": "object"
      -        },
      -        {
      -          "type": "null"
      -        }
      -      ],
      -      "description": "The endpoint's payload, or `null` when Microburbs has no value."
      -    },
      -    "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[SuburbProfile]",
      -  "type": "object",
      -  "x-fastmcp-top-level-schema": "ApiResponse_SuburbProfile_"
      -}New value: +null
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds genuinely new context — a hard cost of 3¢ per call, which is exactly the kind of operational detail annotations cannot express. It does not say what happens when the supplied name is not a canonical SAL (error vs fuzzy match), leaving the main failure mode undisclosed.

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

Conciseness4/5

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

Two sentences plus a bolded price line — front-loaded with the returned geography chain, then the input precondition, then cost. No filler. The inline backtick endpoint reference is slightly awkward but functional.

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?

No output schema exists, so the description must describe returns, and it does by enumerating the geography levels returned. With one parameter and full annotation coverage, the remaining gap is small — chiefly unknown-suburb behavior and whether codes or names are returned.

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

Parameters4/5

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

Schema coverage is 0% and the single parameter is undocumented in the schema, so the description carries the burden. It does so well: it tells the agent the value must be a canonical SAL suburb name and points to where canonical names can be obtained. It could still state whether case or abbreviation normalization is accepted.

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 resource and what it returns: the suburb's upward geography chain enumerated as LGA, SA2/3/4, GCCSA, state, postcode. This clearly separates it from lga_profile or sa4_profile, which profile those regions directly rather than resolving a suburb upward. It does not explicitly name a sibling as an alternative, so it stops short of a 5.

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

Usage Guidelines3/5

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

Useful precondition is given: the suburb_name must be a canonical SAL name, discoverable via the /v1/suburbs/list endpoint (and that endpoint supports filtering by state/LGA/SA4/postcode). However, that is an HTTP endpoint reference rather than a named sibling tool, and there is no guidance on when to pick this over geocode_suburb or the various region profile tools. Usage is implied rather than routed.

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