Skip to main content
Glama
Sign In

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Suburb · Months of Supply

suburbs_market_months_of_supply
Read-onlyIdempotent

Shown in the suburb report as the 'Months of Supply' card in the Overview section.

How many months the current for-sale stock would take to clear at the suburb's current sales rate. Under 2 months is a seller's market.

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

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": "How long current for-sale stock lasts at the suburb's sales rate.",
-          "example": {
-            "area_level": "suburb",
-            "area_name": "Belmont North",
-            "areas": 79,
-            "months_of_supply": 1,
-            "rank": 53
-          },
-          "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"
-            },
-            "areas": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Size of the peer group the rank is out of.",
-              "title": "Areas"
-            },
-            "months_of_supply": {
-              "description": "Months of for-sale stock at the current sales rate. Under 2 = a seller's market.",
-              "title": "Months Of Supply",
-              "type": "number"
-            },
-            "rank": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Position among peer suburbs (1 = most supply).",
-              "title": "Rank"
-            }
-          },
-          "required": [
-            "area_name",
-            "area_level",
-            "months_of_supply"
-          ],
-          "title": "MonthsOfSupply",
-          "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[MonthsOfSupply]",
-  "type": "object",
-  "x-fastmcp-top-level-schema": "ApiResponse_MonthsOfSupply_"
-}New value: +null
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare this a read-only, idempotent, non-destructive, closed-world operation, so the description only needs to add context — and it does: a hard cost of 8¢ per call, the surface where the value appears (Overview 'Months of Supply' card), and a benchmark for reading the number. That pricing disclosure is genuinely useful behavior information absent from the structured fields.

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?

Four short blocks: location in the report, definition, interpretation threshold, and price. Nearly every sentence earns its place, though leading with the UI card location rather than the metric itself delays the essential information slightly.

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?

For a single-parameter read metric with no output schema, the definition, benchmark, and cost are sufficient to call the tool confidently. The remaining gap is that nothing states the return shape or units (a numeric month value), which would help an agent consume the result.

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, with 0% schema description coverage, so the description must carry the burden — and it only implicitly scopes the computation to 'the suburb's current sales rate.' It adds no guidance on name format, ambiguity, or disambiguation (e.g., using geocode_suburb first), which is the main gap for a lookup-style parameter.

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 gives a precise verb-and-resource definition: 'How many months the current for-sale stock would take to clear at the suburb's current sales rate,' which pins down the metric far better than the name alone. It does not explicitly contrast itself with near-neighbors such as suburbs_market_supply_pressure, so sibling differentiation is left implicit.

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 implied through the interpretation rule ('Under 2 months is a seller's market') and the per-call price caveat, which hints the caller should be deliberate about repeated calls. However, there is no explicit when-to-use/when-not-to-use statement or pointer to related tools for deeper supply analysis.

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