Skip to main content
Glama

Microburbs Australian Property Data

Suburb · Affordability

suburbs_market_affordability
Read-onlyIdempotent

Shown in the suburb report as the 'Affordability' card in the Market section.

Our affordability index for the suburb's postcode area.

Price: 5¢ 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_affordability"
  }
}

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": "Microburbs affordability index for the suburb's postcode area.",
      -          "example": {
      -            "area_level": "suburb",
      -            "area_name": "Belmont North",
      -            "avg_salary": 72781.3,
      -            "cg_direction": "-",
      -            "forecast_cg_pa": 4.7,
      -            "index": 41,
      -            "pct_neg_gearing": 5.99,
      -            "poa": "2280",
      -            "price_to_salary": 17.96,
      -            "welfare_pct": 35.25,
      -            "zone": "Cautious"
      -          },
      -          "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"
      -            },
      -            "avg_salary": {
      -              "anyOf": [
      -                {
      -                  "type": "number"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Average salary in the POA (AUD/yr).",
      -              "title": "Avg Salary"
      -            },
      -            "cg_direction": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Capital-growth direction indicator: '++' / '+' / '~' / '-' / '--'.",
      -              "title": "Cg Direction"
      -            },
      -            "forecast_cg_pa": {
      -              "anyOf": [
      -                {
      -                  "type": "number"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Forecast capital growth, percent per year (4.7 = 4.7%/yr).",
      -              "title": "Forecast Cg Pa"
      -            },
      -            "index": {
      -              "anyOf": [
      -                {
      -                  "type": "integer"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Microburbs Affordability Index, 1-100 (higher = stronger affordability-driven capital-growth outlook).",
      -              "title": "Index"
      -            },
      -            "pct_neg_gearing": {
      -              "anyOf": [
      -                {
      -                  "type": "number"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Share of taxpayers negatively gearing (%).",
      -              "title": "Pct Neg Gearing"
      -            },
      -            "poa": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Postcode area (POA) the index is computed for.",
      -              "title": "Poa"
      -            },
      -            "price_to_salary": {
      -              "anyOf": [
      -                {
      -                  "type": "number"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Median house price / average salary multiple.",
      -              "title": "Price To Salary"
      -            },
      -            "welfare_pct": {
      -              "anyOf": [
      -                {
      -                  "type": "number"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Share of income earners on welfare (%).",
      -              "title": "Welfare Pct"
      -            },
      -            "zone": {
      -              "anyOf": [
      -                {
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ],
      -              "description": "Zone label: 'Strong Outlook' / 'Solid' / 'Cautious' / 'Headwind'.",
      -              "title": "Zone"
      -            }
      -          },
      -          "required": [
      -            "area_name",
      -            "area_level"
      -          ],
      -          "title": "Affordability",
      -          "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[Affordability]",
      -  "type": "object",
      -  "x-fastmcp-top-level-schema": "ApiResponse_Affordability_"
      -}New value: +null
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare that this is a read-only, idempotent, non-destructive lookup. The description adds useful behavioral context by stating the cost (5¢ per call) and that the index is calculated for the suburb's postcode area, but it does not explain the index scale, calculation, or return format.

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 description is short and front-loads the core purpose. The pricing note is useful, though the report-card location sentence is more contextual than essential.

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 tool, the description covers the metric and cost but omits what the affordability index values mean and gives no comparative usage guidance. With no output schema, the description could do more to explain the returned data.

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. The description partially compensates by indicating that the lookup is tied to the suburb's postcode area, but it does not specify accepted name formats or edge cases.

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 states a specific resource: an affordability index for the suburb's postcode area, and ties it to the 'Affordability' card in the Market section. It is clear what the tool returns, but it does not distinguish this tool from related siblings such as mortgage stress or median price tools.

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 description mentions where the result is shown in a report, but gives no guidance on when to choose this tool over alternatives such as mortgage stress or median price tools. Usage is only implied by the name and card label.

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