Skip to main content
Glama
Sign In

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Suburb · Vacancy Rate — history

suburbs_market_vacancy_rate_series
Read-onlyIdempotent

Shown in the suburb report as the 'Vacancy Rate' chart tab in the Market section.

Full rental-vacancy history by property type, decimal fractions.

Price: 20¢ 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_series"
  }
}

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": "Full rental-vacancy history by property type.",
-          "example": {
-            "area_level": "suburb",
-            "area_name": "Belmont North",
-            "as_of": "2026-06-28",
-            "house": [
-              {
-                "date": "2021-05-30",
-                "value": 0.00312
-              },
-              {
-                "date": "2026-06-28",
-                "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": [
-                {
-                  "items": {
-                    "description": "One observation in a suburb time series.",
-                    "properties": {
-                      "date": {
-                        "description": "ISO date (YYYY-MM-DD) of the observation.",
-                        "title": "Date",
-                        "type": "string"
-                      },
-                      "value": {
-                        "description": "Series value at that date.",
-                        "title": "Value",
-                        "type": "number"
-                      }
-                    },
-                    "required": [
-                      "date",
-                      "value"
-                    ],
-                    "title": "SeriesPoint",
-                    "type": "object"
-                  },
-                  "type": "array"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "House vacancy series — DECIMAL fractions (0.00842 = 0.84%).",
-              "title": "House"
-            },
-            "unit": {
-              "anyOf": [
-                {
-                  "items": {
-                    "description": "One observation in a suburb time series.",
-                    "properties": {
-                      "date": {
-                        "description": "ISO date (YYYY-MM-DD) of the observation.",
-                        "title": "Date",
-                        "type": "string"
-                      },
-                      "value": {
-                        "description": "Series value at that date.",
-                        "title": "Value",
-                        "type": "number"
-                      }
-                    },
-                    "required": [
-                      "date",
-                      "value"
-                    ],
-                    "title": "SeriesPoint",
-                    "type": "object"
-                  },
-                  "type": "array"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Unit vacancy series — DECIMAL fractions.",
-              "title": "Unit"
-            }
-          },
-          "required": [
-            "area_name",
-            "area_level"
-          ],
-          "title": "VacancyRateSeries",
-          "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[VacancyRateSeries]",
-  "type": "object",
-  "x-fastmcp-top-level-schema": "ApiResponse_VacancyRateSeries_"
-}New value: +null
  2. First observed

TDQS

B3.4/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 closed-world, so the safety profile is covered. The description adds genuinely non-derivable context: the cost ('20¢ per call'), the unit convention (decimal fractions, not percentages), and the property-type segmentation. It stops short of disclosing history depth, frequency, or pagination.

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?

Three short lines, front-loaded with the identifying report location, then the content, then the price. Nothing is redundant, though the report-UI framing is more useful to a human reader than to an agent choosing a tool.

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 must characterize the return value, and it only gives units and segmentation. For a time-series tool the agent still lacks the time span, observation frequency, and ordering, and the sole parameter is undocumented, leaving real gaps for a call that costs money per invocation.

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% with one required parameter, so the description carries the full burden and does not meet it. It never explains suburb_name — no format, matching rules, or examples — and its 'by property type' phrase points at a dimension that has no corresponding parameter, which could mislead.

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 scope: 'Full rental-vacancy history by property type, decimal fractions.' The word 'history' plus the chart-tab reference distinguishes it from a point-in-time sibling such as suburbs_market_vacancy_rate, but the description never names that alternative, so differentiation is inferred rather than stated.

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 only implied: 'history' suggests this is the series counterpart to a current-value tool, and the report-tab reference gives context for where the data appears. There is no explicit when-to-use, when-not-to-use, or named alternative, so the agent must infer selection.

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