Skip to main content
Glama
Sign In

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Suburb · Vacancy Rate

suburbs_market_vacancy_rate
Read-onlyIdempotent

Shown in the suburb report as the 'Vacancy Rate' card in the Overview section.

Suburb-wide rental vacancy rate by property type, as a decimal fraction (0.00842 = 0.84%). Use /market/vacancy-map for the per-mesh-block surface.

Price: 8¢ 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_vacancy_rate"
  }
}

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": "Suburb headline rental vacancy rate, by property type.",
-          "example": {
-            "area_level": "suburb",
-            "area_name": "Belmont North",
-            "as_of": "2026-06-28",
-            "house": {
-              "areas": 28,
-              "rank": 9,
-              "value": 0.00842
-            }
-          },
-          "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": [
-                {
-                  "description": "A published figure with its position among peer suburbs.",
-                  "properties": {
-                    "areas": {
-                      "anyOf": [
-                        {
-                          "type": "integer"
-                        },
-                        {
-                          "type": "null"
-                        }
-                      ],
-                      "description": "Size of the peer group the rank is out of.",
-                      "title": "Areas"
-                    },
-                    "rank": {
-                      "anyOf": [
-                        {
-                          "type": "integer"
-                        },
-                        {
-                          "type": "null"
-                        }
-                      ],
-                      "description": "Position among peer areas (1 = highest).",
-                      "title": "Rank"
-                    },
-                    "value": {
-                      "description": "The figure itself.",
-                      "title": "Value",
-                      "type": "number"
-                    }
-                  },
-                  "required": [
-                    "value"
-                  ],
-                  "title": "RankedValue",
-                  "type": "object"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "House vacancy rate as a DECIMAL fraction (0.00842 = 0.84%), with peer rank."
-            },
-            "unit": {
-              "anyOf": [
-                {
-                  "description": "A published figure with its position among peer suburbs.",
-                  "properties": {
-                    "areas": {
-                      "anyOf": [
-                        {
-                          "type": "integer"
-                        },
-                        {
-                          "type": "null"
-                        }
-                      ],
-                      "description": "Size of the peer group the rank is out of.",
-                      "title": "Areas"
-                    },
-                    "rank": {
-                      "anyOf": [
-                        {
-                          "type": "integer"
-                        },
-                        {
-                          "type": "null"
-                        }
-                      ],
-                      "description": "Position among peer areas (1 = highest).",
-                      "title": "Rank"
-                    },
-                    "value": {
-                      "description": "The figure itself.",
-                      "title": "Value",
-                      "type": "number"
-                    }
-                  },
-                  "required": [
-                    "value"
-                  ],
-                  "title": "RankedValue",
-                  "type": "object"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Unit vacancy rate as a DECIMAL fraction, with peer rank."
-            }
-          },
-          "required": [
-            "area_name",
-            "area_level"
-          ],
-          "title": "VacancyRate",
-          "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[VacancyRate]",
-  "type": "object",
-  "x-fastmcp-top-level-schema": "ApiResponse_VacancyRate_"
-}New value: +null
  2. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so safety behavior needs no restating. The description adds two useful non-annotation facts: output scaling as a decimal fraction and a per-call price of 8¢. It says nothing about data recency, coverage period, or whether the result is a single figure or a per-property-type breakdown, which leaves real behavioral gaps.

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-loads the metric definition and unit convention, then the sibling alternative, then the price. The opening sentence about which report card it appears under is UI context that a caller doesn't strictly need, but it is short and does aid report mapping.

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 output schema, the description does the essential job of specifying the return value's type and scaling. The one unresolved point is 'by property type' — the schema has no property-type parameter, so whether the response is split by type is left ambiguous.

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?

There is one required parameter, `suburb_name`, at 0% schema coverage, so the description must carry the load; it only implies scope via 'suburb-wide' and gives no expected format (e.g., 'Bondi, NSW' vs a suburb ID). The parameter name is largely self-documenting, which keeps this at minimum-viable rather than failing.

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?

Names a concrete metric (suburb-wide rental vacancy rate), pins down the unit convention ('0.00842 = 0.84%'), and explicitly contrasts itself with the per-mesh-block map tool. An agent can tell immediately what value this returns and how to read it.

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?

Explicitly routes the agent to `/market/vacancy-map` when mesh-block granularity is wanted, which is a real when-to-use-else decision. It stops short of an exhaustive exclusion rule (e.g., versus the series variant for trend-over-time), but the positive guidance is clear.

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