Skip to main content
Glama

Microburbs Australian Property Data

Vacancy rate (by suburb)

suburbs_market_vacancy_map
Read-onlyIdempotent

Shown in the suburb report as the 'Vacancy rate' map layer in the Market section.

Calibrated rental-vacancy rate for each mesh block in the suburb.

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

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": "Per-mesh-block rental vacancy rates for the suburb.",
      -          "example": {
      -            "area_level": "suburb",
      -            "area_name": "Belmont North",
      -            "mbs": [
      -              {
      -                "has_listings": true,
      -                "mb": "10431160000",
      -                "rental_listings": 15,
      -                "rental_stock": 23.3,
      -                "vacancy_pct": 0.74
      -              }
      -            ]
      -          },
      -          "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"
      -            },
      -            "mbs": {
      -              "description": "Per-mesh-block vacancy rates.",
      -              "items": {
      -                "description": "Calibrated rental-vacancy rate for one mesh block.",
      -                "properties": {
      -                  "has_listings": {
      -                    "anyOf": [
      -                      {
      -                        "type": "boolean"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ],
      -                    "description": "Whether the MB currently has rental listings.",
      -                    "title": "Has Listings"
      -                  },
      -                  "mb": {
      -                    "description": "ABS mesh-block code (MB_CODE21).",
      -                    "title": "Mb",
      -                    "type": "string"
      -                  },
      -                  "rental_listings": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ],
      -                    "description": "Current rental listings in the MB.",
      -                    "title": "Rental Listings"
      -                  },
      -                  "rental_stock": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ],
      -                    "description": "Estimated rental dwellings in the MB.",
      -                    "title": "Rental Stock"
      -                  },
      -                  "vacancy_pct": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ],
      -                    "description": "Vacancy rate (%, calibrated to the suburb's published rate).",
      -                    "title": "Vacancy Pct"
      -                  }
      -                },
      -                "required": [
      -                  "mb"
      -                ],
      -                "title": "VacancyMb",
      -                "type": "object"
      -              },
      -              "title": "Mbs",
      -              "type": "array"
      -            }
      -          },
      -          "required": [
      -            "area_name",
      -            "area_level",
      -            "mbs"
      -          ],
      -          "title": "VacancyMap",
      -          "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[VacancyMap]",
      -  "type": "object",
      -  "x-fastmcp-top-level-schema": "ApiResponse_VacancyMap_"
      -}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 establish read-only, idempotent, non-destructive, closed-world behavior. The description adds meaningful context beyond that: the data is calibrated, returned per mesh block, and costs 20¢ per call, which is useful for agent cost-awareness.

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?

The definition is short and front-loads the core purpose. The report-placement sentence adds some context, and the pricing note is clear and easy to spot.

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?

For a simple one-parameter read-only lookup, the description covers purpose, granularity, and cost. It leaves a gap around the required suburb_name input and does not clarify the map-layer response shape, though no output schema exists.

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% for the single required suburb_name parameter. The description only alludes to 'the suburb' without specifying expected name format, matching rules, or any other semantics needed to populate the parameter correctly.

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?

The description names the specific resource and granularity: a calibrated rental-vacancy rate for each mesh block in a suburb. It distinguishes itself from a suburb-level rate by emphasizing 'map layer' and 'each mesh block', though it does not explicitly contrast with the vacancy_rate sibling.

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?

The only usage context is that it appears as the 'Vacancy rate' map layer in the suburb report's Market section. There is no guidance on when to choose this map tool over suburbs_market_vacancy_rate or suburbs_market_vacancy_rate_series.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources