Suburb · Rental vacancy rate — full series
suburbs_market_vacancy_rate_seriesFull rental-vacancy history by property type, decimal fractions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| suburb_name | Yes |
suburbs_market_vacancy_rate_seriesFull rental-vacancy history by property type, decimal fractions.
| Name | Required | Description | Default |
|---|---|---|---|
| suburb_name | Yes |
Changes observed during successful MCP inspections.
Output 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: +nullDoes the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is clear. The description adds that the output is 'decimal fractions' and covers 'full history by property type', which provides some behavioral context beyond annotations. However, it does not disclose any limitations such as pagination, time range, or whether multiple property types are returned as separate series.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single efficient sentence with no wasted words: 'Full rental-vacancy history by property type, decimal fractions.' The key differentiator ('full series') is front-loaded, and every clause adds semantic value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter tool with safety annotations present, the description is adequate but not complete. It communicates the output nature and format, but does not specify the time period covered, the meaning of 'by property type', or what an agent should expect in the response structure. Since there is no output schema, a bit more detail would help.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate for the sole parameter, suburb_name. It does not explain the parameter at all – no format, examples, or clarification that it expects a standard suburb name. The parameter name is self-explanatory to a degree, but with zero schema coverage and no help from the description, an agent has no guidance on valid inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the resource clearly: 'Full rental-vacancy history' with the addition 'by property type' and 'decimal fractions'. The name and title reinforce that it is a suburb-level series, distinguishing it from the sibling 'suburbs_market_vacancy_rate' (single rate) and 'suburbs_market_vacancy_map'. However, it lacks an explicit verb like 'get' or 'list', though the meaning is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no guidance on when to use this tool versus alternatives. It does not mention the non-series vacancy tool, the map variant, or any context for selecting this full series over other market tools. An agent would have to infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.