Skip to main content
Glama

Microburbs Australian Property Data

Suburb · Months of supply

suburbs_market_months_of_supply
Read-onlyIdempotent

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.

Input Schema

TableJSON 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.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering safety. The description adds the operational definition of the metric (months to clear) and the market interpretation, which is useful contextual behavior. However, it does not disclose other behavioral aspects such as return format, precision, or error handling (e.g., invalid suburb). With annotations present, the description adds some value beyond them but is not rich in behavioral caveats.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no fluff: the first defines the metric, the second provides a key threshold. The core definition is front-loaded, making it immediately clear what the tool does. Every sentence earns its place; there is no redundant information.

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 tool with a single simple parameter, safety annotations, and no output schema, the description is nearly complete. It explains what the tool computes and how to interpret the result. It does not explicitly state the return format (e.g., a number representing months), but this is implied. The description also helps distinguish this metric from related siblings. Overall, it provides sufficient context for an agent to call it correctly and understand the response.

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?

Schema documentation coverage is 0% – the parameter suburb_name has no description in the schema. The tool description refers to 'the suburb's current sales rate,' which clarifies that the parameter is the suburb of interest, but it doesn't explicitly state that the parameter must be a valid suburb name or provide format guidance. This is some compensation for the missing schema description, but it is minimal given the parameter is self-explanatory. A baseline of 3 is appropriate since the description adds a little meaning beyond the schema but does not fully compensate for the lack of parameter documentation.

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?

The description clearly states the metric computed: 'How many months the current for-sale stock would take to clear at the suburb's current sales rate.' This is a specific verb-object pair (compute months of supply) that is distinct from sibling tools like days_on_market or stock_on_market. It also provides an interpretive threshold ('Under 2 months is a seller's market'), which further clarifies the tool's purpose.

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?

The description gives an interpretation of the result (seller's market threshold), which implies it is used to gauge market tightness, but it does not explicitly state when to use this tool instead of other market metrics like suburbs_market_supply_pressure, suburbs_market_days_on_market, or suburbs_market_stock_on_market. No alternatives are named, and no exclusionary guidance is provided. The context (market balance) is only implied, not explicit.

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