Skip to main content
Glama

Microburbs Australian Property Data

Similar Suburbs

suburbs_similar
Read-onlyIdempotent

Shown in the suburb report as its 'Similar Suburbs' section.

Up to 10 suburbs ranked closest by our similarity model (typically 5), each with a short comparison and latest median house and unit price. Not every suburb has a comparison set.

Price: 60¢ 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_similar"
  }
}

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": [
      -        {
      -          "items": {
      -            "additionalProperties": true,
      -            "description": "One similar-suburb recommendation.",
      -            "example": {
      -              "area_level": "suburb",
      -              "area_name": "Coogee",
      -              "keywords": "Quieter, Family-friendly",
      -              "price": {},
      -              "summary": "Like Bondi, Coogee also has a buzzing beach culture and vibrant cafe scene. However, Coogee is generally considered quieter and more family-friendly."
      -            },
      -            "properties": {
      -              "area_level": {
      -                "description": "Always 'suburb'.",
      -                "title": "Area Level",
      -                "type": "string"
      -              },
      -              "area_name": {
      -                "description": "Similar suburb's SAL name.",
      -                "title": "Area Name",
      -                "type": "string"
      -              },
      -              "keywords": {
      -                "anyOf": [
      -                  {
      -                    "type": "string"
      -                  },
      -                  {
      -                    "type": "null"
      -                  }
      -                ],
      -                "description": "Comma-separated tags describing the suburb.",
      -                "title": "Keywords"
      -              },
      -              "price": {
      -                "anyOf": [
      -                  {
      -                    "description": "A scalar value broken down by property type.",
      -                    "properties": {
      -                      "house": {
      -                        "anyOf": [
      -                          {
      -                            "type": "number"
      -                          },
      -                          {
      -                            "type": "null"
      -                          }
      -                        ],
      -                        "description": "Value for houses.",
      -                        "title": "House"
      -                      },
      -                      "unit": {
      -                        "anyOf": [
      -                          {
      -                            "type": "number"
      -                          },
      -                          {
      -                            "type": "null"
      -                          }
      -                        ],
      -                        "description": "Value for units / apartments.",
      -                        "title": "Unit"
      -                      }
      -                    },
      -                    "title": "PriceByType",
      -                    "type": "object"
      -                  },
      -                  {
      -                    "type": "null"
      -                  }
      -                ],
      -                "description": "Median sale prices for this similar suburb."
      -              },
      -              "summary": {
      -                "anyOf": [
      -                  {
      -                    "type": "string"
      -                  },
      -                  {
      -                    "type": "null"
      -                  }
      -                ],
      -                "description": "Plain-language explanation of the similarity.",
      -                "title": "Summary"
      -              }
      -            },
      -            "required": [
      -              "area_name",
      -              "area_level"
      -            ],
      -            "title": "SimilarSuburb",
      -            "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[SimilarSuburb]]",
      -  "type": "object",
      -  "x-fastmcp-top-level-schema": "ApiResponse_list_SimilarSuburb__"
      -}New value: +null
  2. First observed

TDQS

A3.7/5.0
Behavior4/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 new behavior: a per-call cost of 60 cents, a variable result count (up to 10, typically 5), and the possibility of an empty result set. It does not say what happens on an unknown suburb name or whether the charge applies when no comparison set exists.

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 result definition and followed by the cost. Almost no waste. The opening clause about being 'Shown in the suburb report' is slightly indirect as a lead but usefully anchors the output to a known section.

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 has to define return values, and it does: comparison text plus median house and unit prices, with count expectations. It also flags the empty-result case. Missing pieces are the error behavior for an invalid suburb name and whether the 60 cent charge still applies when no comparison set is returned.

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?

There is a single required parameter, suburb_name, whose name is self-explanatory, and the schema carries no description (0% coverage). The description does not clarify expected format, such as whether a state or postcode disambiguation is needed, but with one obvious string parameter the burden is light. Baseline 3 is appropriate.

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 states the resource precisely: up to 10 suburbs ranked by a similarity model, each with a short comparison plus latest median house and unit price. It maps the output to a known UI section ('Similar Suburbs'), which makes the result shape unambiguous. It never uses an explicit verb like 'returns' or 'lists', and it names no sibling, 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?

Usage is only implied by the subject matter: an agent can infer this is the tool for finding comparable suburbs. There is no explicit when-to-use or when-not-to-use guidance and no pointer to an alternative among the many suburbs_area_stats_* and suburbs_amenities_* siblings. The one useful caveat, that not every suburb has a comparison set, is a coverage note rather than selection guidance.

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