Skip to main content
Glama

Microburbs Australian Property Data

Similar suburbs

suburbs_similar
Read-onlyIdempotent

Top-10 suburbs ranked closest by Microburbs' similarity model.

Input Schema

TableJSON 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

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the description only needs to add behavioral nuance. It does add the top-10 limit and the similarity-model basis, which is useful, but it does not explain what 'similarity' is based on or what happens for unknown suburb names.

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?

One sentence delivers the core result type, the ranking criterion, and the count. There is no filler, and the key information is front-loaded.

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 simple read-only lookup with one parameter, the description is minimally viable. However, with no output schema, it does not clarify what the returned entries contain (names only, similarity scores, states, etc.), and it offers no guidance on input format or error cases.

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

Parameters2/5

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

The schema has 0% description coverage and the tool description adds nothing about the suburb_name parameter. It does not specify expected format, whether a state or region is required, or how ambiguous suburb names should be disambiguated.

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 clearly states the tool returns the top-10 suburbs ranked by a similarity model. It names the resource (suburbs) and the operation (ranking), but it does not differentiate itself from the similarly named sibling tool suburbs_market_comparable_suburbs, so it falls just 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 Guidelines2/5

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

The description gives no guidance on when to use this tool versus alternatives such as suburbs_market_comparable_suburbs or suburbs_finder_search. There is no mention of preferred use cases, exclusions, or conditions that would make this tool the right choice.

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