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. Values of unit percent are fractions (0.06 = 6%) in filter.

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.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "suburbs_finder_fields"
  }
}

Input 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

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and openWorldHint=false, so safety is covered; the description goes further by disclosing that `percent`-unit values are fractions (0.06 = 6%) and that unit-prefixed fields are only populated for ~13–54% of suburbs, meaning a unit filter silently won't match uncovered suburbs. Those are real behavioral caveats that change how a caller interprets results. It omits anything about the shape of the returned catalog beyond 'label and unit' and the stray '0c.' token is unexplained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core content is front-loaded and dense with useful detail, but the opening '0c.' is a stray artifact that reads as a truncation bug, and the closing '**Free.**' markdown tag is unpolished for a tool description. The line breaks inside sentences also break the prose mid-clause, slightly hurting scanability.

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?

With no parameters, no output schema and no nested objects, the description should carry the burden — and it largely does: it explains what the returned catalog contains (label + unit), how to interpret unit values, and the population caveat for unit fields. The only meaningful gap is that it never states the returned structure or how many fields to expect, which for a catalog tool would help an agent plan.

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?

Zero parameters, so the baseline is 4. The description still spends its space on semantics that matter downstream — the meaning of the `percent` unit, the distinction between `unit`-prefixed (apartment) and unprefixed (house) keys, and the fact that both can be combined in one query — which is exactly the interpretive context a field catalog needs.

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?

States a specific resource clearly: a catalog of 'every field you can filter / sort on, with its label and unit,' which tells an agent this is a metadata reference, not a data query. It does not explicitly name the sibling tools (e.g. suburbs_finder_search) it exists to support, so the differentiation from the 30+ area_stats/finder siblings is only implied by the word 'catalog'.

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 implied rather than stated: an agent can infer this is a discovery step before building a filter/sort query, but there is no explicit 'call this first' instruction, no exclusion of alternatives, and no mention of what to do with the returned fields. The house/unit note gives a hint about query construction but is not framed as 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