Skip to main content
Glama
Sign In

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Neighbouring suburbs

suburbs_hero_neighbours
Read-onlyIdempotent

Nearest neighbouring suburbs with distance in km, closest first.

Price: 5¢ 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_hero_neighbours"
  }
}

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": [
-        {
-          "additionalProperties": true,
-          "description": "Nearest neighbouring suburbs, closest first.",
-          "example": {
-            "area_level": "suburb",
-            "area_name": "Belmont North",
-            "neighbours": [
-              {
-                "dist_km": 1,
-                "sa3": "Lake Macquarie - East",
-                "sal": "Floraville"
-              },
-              {
-                "dist_km": 1.4,
-                "sa3": "Lake Macquarie - East",
-                "sal": "Belmont (NSW)"
-              }
-            ]
-          },
-          "properties": {
-            "area_level": {
-              "description": "Always 'suburb' for these endpoints.",
-              "title": "Area Level",
-              "type": "string"
-            },
-            "area_name": {
-              "description": "Suburb (SAL) name.",
-              "title": "Area Name",
-              "type": "string"
-            },
-            "neighbours": {
-              "description": "Neighbouring suburbs ordered by distance (closest first).",
-              "items": {
-                "additionalProperties": true,
-                "description": "One neighbouring suburb.",
-                "example": {
-                  "dist_km": 1,
-                  "sa3": "Lake Macquarie - East",
-                  "sal": "Floraville"
-                },
-                "properties": {
-                  "dist_km": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Straight-line distance between the two suburbs' boundary centroids (km) — not the gap between boundaries, so touching suburbs still show a positive distance.",
-                    "title": "Dist Km"
-                  },
-                  "sa3": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "ABS SA3 region of the neighbour.",
-                    "title": "Sa3"
-                  },
-                  "sal": {
-                    "description": "Neighbouring suburb (SAL) name.",
-                    "title": "Sal",
-                    "type": "string"
-                  }
-                },
-                "required": [
-                  "sal"
-                ],
-                "title": "HeroNeighbourRow",
-                "type": "object"
-              },
-              "title": "Neighbours",
-              "type": "array"
-            }
-          },
-          "required": [
-            "area_name",
-            "area_level",
-            "neighbours"
-          ],
-          "title": "HeroNeighbours",
-          "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[HeroNeighbours]",
-  "type": "object",
-  "x-fastmcp-top-level-schema": "ApiResponse_HeroNeighbours_"
-}New value: +null
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely useful behavior beyond that: unit of measure (km), result ordering (closest first) and a per-call price of 5¢. It omits how many neighbours are returned and whether suburb_name must match exactly, which matters for a paid call.

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, zero filler, with the core behavior front-loaded and the cost note placed after. Nothing could be cut without losing information.

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

Completeness3/5

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

For a one-parameter lookup with no output schema, the essentials are there, and disclosing the price is a real plus. The gaps are result cardinality and input format expectation, both of which an agent needs to call this correctly and budget for it.

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 0%, so the description carries the burden of explaining the single parameter. It implies suburb_name is the origin suburb but says nothing about expected format (suburb name vs. ID/postcode) or matching behavior. Marginal compensation for the coverage gap.

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?

The description names a specific resource (neighbouring suburbs) and adds two defining traits: distance in km and closest-first ordering. It does not, however, distinguish itself from the similarly named sibling suburbs_shapes_neighbours, so an agent must infer which one to pick.

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?

Usage is only implied: the agent can infer this answers 'what suburbs are adjacent to X'. There is no explicit when-to-use statement, no exclusion, and no pointer to the sibling shape-based neighbour tool or the properties_neighbours alternative.

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