Skip to main content
Glama

Microburbs Australian Property Data

Suburb · Finder field catalog

suburbs_finder_fields
Read-onlyIdempotent

Every field you can filter / sort on, with its label and unit. 0c.

Houses and units are separate keys: the unit-prefixed ones (unitMedianPrice, unitGrossYield, unitMedianRent, …) are the apartment market, the unprefixed market keys are houses, and both can be filtered in the same query. Unit fields are NOT nationally populated — they only exist where a suburb has a unit market (roughly 13-54% of suburbs depending on the field), so a suburb with no unit market simply won't match a unit filter.

Free.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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": "The finder field catalog.",
      -          "example": {
      -            "fields": [
      -              {
      -                "key": "grossYield",
      -                "label": "Gross rental yield",
      -                "unit": "percent"
      -              }
      -            ]
      -          },
      -          "properties": {
      -            "fields": {
      -              "description": "Every filterable / returnable field.",
      -              "items": {
      -                "description": "One filterable / sortable metric in the finder catalog.",
      -                "example": {
      -                  "key": "grossYield",
      -                  "label": "Gross rental yield",
      -                  "unit": "percent"
      -                },
      -                "properties": {
      -                  "key": {
      -                    "description": "camelCase field key — pass this in `filter` / `sort`.",
      -                    "title": "Key",
      -                    "type": "string"
      -                  },
      -                  "label": {
      -                    "description": "Human-readable label.",
      -                    "title": "Label",
      -                    "type": "string"
      -                  },
      -                  "unit": {
      -                    "description": "Unit of the value — currency | percent | count | days | km | score | index.",
      -                    "title": "Unit",
      -                    "type": "string"
      -                  }
      -                },
      -                "required": [
      -                  "key",
      -                  "label",
      -                  "unit"
      -                ],
      -                "title": "FinderField",
      -                "type": "object"
      -              },
      -              "title": "Fields",
      -              "type": "array"
      -            }
      -          },
      -          "required": [
      -            "fields"
      -          ],
      -          "title": "FieldsResponse",
      -          "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[FieldsResponse]",
      -  "type": "object",
      -  "x-fastmcp-top-level-schema": "ApiResponse_FieldsResponse_"
      -}New value: +null
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so safety is covered. The description adds significant context: it explains the free tier limitation ('0c') and the key behavioral quirk about unit fields not being nationally populated, which is beyond the structured fields. It gives a concrete example of the parameter naming convention. This is valuable behavioral info.

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?

The description is compact yet information-dense, front-loading the core purpose. It uses bullet-like formatting for the unit market explanation, making it scannable. No redundant phrasing; every sentence contributes value: purpose, house/unit distinction, and national data caveat.

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

Completeness5/5

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

For a zero-parameter catalog tool with no output schema, the description fully covers what an agent needs: what the catalog contains, how fields are named, and critical data caveats. It explains the free tier and the unit market population nuance. There is no missing information for an agent to misuse this tool.

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?

The tool has zero parameters, so schema coverage is trivially 100%. The description explains the semantic meaning of parameter prefixes (unit- vs unprefixed) and the implications for filtering, which is beyond the schema. It also explains the label/unit concept. This is a strong compensation given no parameter descriptions exist.

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?

The description clearly states it is a catalog of every filterable/sortable field with label and unit, distinguishing it from data-returning tools. It explicitly differentiates house vs unit markets, which is a specific and actionable resource. It is distinct from siblings like suburbs_finder_search, which likely searches suburbs, and suburbs_finder_count, which counts results.

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?

It explains when to use this tool: to understand available fields for filtering/sorting in other finder tools. It implies this is a reference rather than a data tool. It does not explicitly exclude alternatives, but the nature of a catalog is clear. It also notes that unit fields are not nationally populated, which is a key usage caveat.

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