Skip to main content
Glama

Microburbs Australian Property Data

Comparable suburbs

suburbs_market_comparable_suburbs
Read-onlyIdempotent

Candidate comparison suburbs: every other suburb in the same statistical region (SA3), as canonical SAL names. Not ranked by similarity and not filtered by size or price; in regional areas the list can be long. Use the similar-suburbs endpoint for a ranked match.

Price: 10¢ 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_market_comparable_suburbs"
  }
}

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": "Same-SA3 comparable-suburb candidates.",
      -          "example": {
      -            "area_level": "suburb",
      -            "area_name": "Belmont North",
      -            "comparable_suburbs": [
      -              "Argenton",
      -              "Belmont (NSW)",
      -              "Belmont South"
      -            ],
      -            "n": 49
      -          },
      -          "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"
      -            },
      -            "comparable_suburbs": {
      -              "description": "Canonical SAL names in the same SA3.",
      -              "items": {
      -                "type": "string"
      -              },
      -              "title": "Comparable Suburbs",
      -              "type": "array"
      -            },
      -            "n": {
      -              "anyOf": [
      -                {
      -                  "type": "integer"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Number of candidates.",
      -              "title": "N"
      -            }
      -          },
      -          "required": [
      -            "area_name",
      -            "area_level",
      -            "comparable_suburbs"
      -          ],
      -          "title": "ComparableSuburbs",
      -          "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[ComparableSuburbs]",
      -  "type": "object",
      -  "x-fastmcp-top-level-schema": "ApiResponse_ComparableSuburbs_"
      -}New value: +null
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety profile is covered. The description adds genuinely new behavioral facts beyond annotations: results are not ranked by similarity, not filtered by size or price, may be long in regional areas, and cost 10¢ per call — the pricing and unbounded-length warnings are the most valuable additions. Return format details (ordering, pagination) remain unstated.

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?

Three compact sentences front-loading what the tool returns, followed by exclusions and the alternative endpoint, then a short bolded price note. Every sentence carries information; only minor tightening is possible.

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 convey return content, which it does (canonical SAL names, list of peer suburbs, possibly long, unranked). Cost and length warnings round it out; only input-format and ordering specifics are left ambiguous.

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?

With a single parameter at 0% schema description coverage, the description does some compensating work by implying the argument identifies a suburb whose SA3 peers are returned and by noting outputs are canonical SAL names. It does not say whether the input should be a SAL name, a colloquial name, or be qualified by state, which is the main ambiguity for a 1-param lookup.

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 resource and scope: 'every other suburb in the same statistical region (SA3), as canonical SAL names.' It also explicitly distinguishes itself from a ranking-style result and from the 'similar-suburbs endpoint', so an agent can identify what this tool returns without reading further.

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 clear context (regional areas produce long lists) and explicitly routes ranked-similarity needs to the 'similar-suburbs endpoint for a ranked match'. What is missing is positive guidance on when this unranked list is the right choice over ranking, and no prerequisites (e.g. input naming conventions) are stated.

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