Skip to main content
Glama
Sign In

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Suburb · Gross Yield

suburbs_market_yield_pct
Read-onlyIdempotent

Shown in the suburb report as the 'Gross Yield' headline figure in the Market section.

Gross rental yield = median weekly rent x 52 / median sale price, as a decimal fraction (0.0335 = 3.35%), for houses and units separately. Each value carries its own date (house_as_of, unit_as_of).

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_market_yield_pct"
  }
}

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": [
-        {
-          "additionalProperties": true,
-          "description": "Gross rental yield for the suburb, houses and units separately.\n\n⚠️ **Unit trap:** despite the `_pct` name, the figures here are\n**decimal fractions** — `0.0346` means 3.46%, so multiply by 100 to\ndisplay. The per-microburb version of the same metric\n(`/market/yield-map`) reports it the other way, as a percent (3.46).\nBoth are deliberate; just be sure which endpoint you are reading.\n\nGross throughout: annual rent over price, before rates, strata,\nmanagement, insurance or vacancy.",
-          "example": {
-            "area_level": "suburb",
-            "area_name": "Belmont North",
-            "as_of": "2026-05-24",
-            "house": 0.0335,
-            "unit": 0.0384
-          },
-          "properties": {
-            "area_level": {
-              "description": "Always 'suburb' for these endpoints.",
-              "title": "Area Level",
-              "type": "string"
-            },
-            "area_name": {
-              "description": "Suburb (SAL) name.",
-              "title": "Area Name",
-              "type": "string"
-            },
-            "as_of": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Date of the most recent observation (YYYY-MM-DD).",
-              "title": "As Of"
-            },
-            "house": {
-              "anyOf": [
-                {
-                  "type": "number"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Gross rental yield for houses as a decimal fraction (0.0346 = 3.46%) — median weekly house rent × 52 ÷ median house price.",
-              "title": "House"
-            },
-            "unit": {
-              "anyOf": [
-                {
-                  "type": "number"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Gross rental yield for units as a decimal fraction (0.0384 = 3.84%), same calculation as `house`. Usually higher than the house yield, since units cost less relative to the rent they earn.",
-              "title": "Unit"
-            }
-          },
-          "required": [
-            "area_name",
-            "area_level"
-          ],
-          "title": "YieldPct",
-          "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[YieldPct]",
-  "type": "object",
-  "x-fastmcp-top-level-schema": "ApiResponse_YieldPct_"
-}New value: +null
  2. First observed

TDQS

B3.2/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive, closed-world behavior, and the description adds genuinely new context: the formula, the decimal-fraction output convention, separate house/unit values with their own as_of dates, and a per-call price of 5¢. It stops short of describing missing-data or error behavior for suburbs without sufficient sales, which matters for an open-ended suburb name input.

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 identity and formula in three tight sentences plus a cost note; nothing is wasted. The first clause partially restates the title, but it earns its place by placing the figure in the report's Market section.

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?

With no output schema, the description does well to explain the returned values, units, and per-value dates, and it discloses cost. The gap is the input side: a required suburb_name with zero schema documentation is left completely underspecified, which is the main completeness failure for a one-parameter lookup tool.

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?

Schema description coverage is 0% and the sole parameter suburb_name is never mentioned in the description, so no format guidance (suburb name vs. postcode, state disambiguation) is supplied anywhere. The description does explain the returned fields, but for the input it adds nothing over the bare schema.

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 metric ('Gross Yield' headline in the Market section) plus the exact computation, so an agent knows precisely what value comes back. It does not, however, distinguish itself from the sibling suburbs_market_yield_pct_series, which a name-aware agent would have to disambiguate on its own.

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?

There is no when-to-use or when-not-to-use guidance; the opening clause only says where the figure appears in a report, not when an agent should call this tool instead of the series, map, or affordability siblings. The agent must infer usage from the sibling names alone.

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