Skip to main content
Glama
Sign In

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Suburb · Bedrooms

suburbs_area_stats_bedrooms
Read-onlyIdempotent

How many bedrooms homes have: studios through six or more, for all dwellings and separately for houses, townhouses and apartments, plus people per bedroom, for every suburb and council area.

Coverage: About 10,700 suburbs and localities and 545 council areas across Australia, in all states and territories (areas with too few people or homes for reliable figures are left out); one snapshot at 10 August 2021. Current to 2021-08-10. Full description, field list and method: /v1/datasets/bedrooms.

Price: 5¢ 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_area_stats_bedrooms"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoLast period to include, same formats as `from`.
fromNoFirst period to include: 2020, 2020-Q3, 2020-07 or 2020-07-01.
fieldsNoComma-separated subset of: total_occupied_dwellings, studio_count, studio_pct, one_bedroom_count, one_bedroom_pct, two_bedrooms_count, two_bedrooms_pct, three_bedrooms_count, three_bedrooms_pct, four_bedrooms_count, four_bedrooms_pct, five_bedrooms_count, five_bedrooms_pct, six_plus_bedrooms_count, six_plus_bedrooms_pct, bedrooms_not_stated_count, bedrooms_not_stated_pct, total_house, house_studio_count, house_studio_pct, house_one_bedroom_count, house_one_bedroom_pct, house_two_bedrooms_count, house_two_bedrooms_pct, house_three_bedrooms_count, house_three_bedrooms_pct, house_four_bedrooms_count, house_four_bedrooms_pct, house_five_bedrooms_count, house_five_bedrooms_pct, house_six_plus_bedrooms_count, house_six_plus_bedrooms_pct, house_bedrooms_not_stated_count, house_bedrooms_not_stated_pct, total_townhouse, townhouse_studio_count, townhouse_studio_pct, townhouse_one_bedroom_count, townhouse_one_bedroom_pct, townhouse_two_bedrooms_count, townhouse_two_bedrooms_pct, townhouse_three_bedrooms_count, townhouse_three_bedrooms_pct, townhouse_four_bedrooms_count, townhouse_four_bedrooms_pct, townhouse_five_bedrooms_count, townhouse_five_bedrooms_pct, townhouse_six_plus_bedrooms_count, townhouse_six_plus_bedrooms_pct, townhouse_bedrooms_not_stated_count, townhouse_bedrooms_not_stated_pct, total_apartment, apartment_studio_count, apartment_studio_pct, apartment_one_bedroom_count, apartment_one_bedroom_pct, apartment_two_bedrooms_count, apartment_two_bedrooms_pct, apartment_three_bedrooms_count, apartment_three_bedrooms_pct, apartment_four_bedrooms_count, apartment_four_bedrooms_pct, apartment_five_bedrooms_count, apartment_five_bedrooms_pct, apartment_six_plus_bedrooms_count, apartment_six_plus_bedrooms_pct, apartment_bedrooms_not_stated_count, apartment_bedrooms_not_stated_pct, persons_per_bedroom. Omit for all.
suburb_nameYesSuburb name exactly as /v1/suburbs/list returns it, e.g. `Bondi` or `St Kilda (Vic.)`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

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 this description only needs to add operating context — and it does: exact coverage (~10,700 suburbs, 545 council areas), an exclusion rule for unreliable small areas, a single 2021-08-10 snapshot, and a 5¢ per-call price. The single-snapshot note is especially valuable because it reveals that time range is effectively fixed, which the annotations cannot convey. It does not describe response shape or per-call limits beyond price.

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?

Front-loaded with the substantive answer to 'what do I get', followed by coverage, snapshot date, doc link and price, which is a sensible priority order. There is mild redundancy between 'one snapshot at 10 August 2021' and 'Current to 2021-08-10', and the parenthetical asides add length, but nothing is genuinely wasted.

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?

For a four-parameter, read-only, single-snapshot dataset tool with no output schema, the description supplies what an agent needs: what is measured, the population covered, the temporal limitations, the cost, and where the full field list lives. The one residual gap is that a `council area` mention sits alongside an LGA-specific sibling without clarifying which to prefer for council-level queries.

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?

Schema description coverage is 100%, so every parameter including the large `fields` enumeration is already documented in structured data, establishing a baseline of 3. The description corroborates the field content (bedroom buckets by dwelling type, persons per bedroom) and implicitly constrains `from`/`to` by stating there is only one 2021 snapshot. It adds no syntax or behavioural detail about how `fields` interacts with output size.

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 and measure set: bedroom counts from studio to six-plus, split by dwelling type (house, townhouse, apartment) plus persons per bedroom, for suburbs and council areas. An agent can immediately tell this is a bedroom-distribution dataset rather than an ancestry or income dataset. It stops short of naming the sibling `lga_area_stats_bedrooms` or explaining why one would pick suburb-level over LGA-level data.

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 by the stated scope and coverage rather than prescribed: the agent learns the tool covers all Australian suburbs and council areas with a minimum-population exclusion, which implicitly defines when it applies. No explicit when-not-to-use condition, no named alternative, and no guidance on pairing with `/v1/suburbs/list` or `geocode_suburb` to resolve a name beyond the parameter description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Microburbs Australian Property Data toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources