Suburb · Affordability index
suburbs_market_affordabilityMicroburbs affordability index for the suburb's postcode area.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| suburb_name | Yes |
suburbs_market_affordabilityMicroburbs affordability index for the suburb's postcode area.
| 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": "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: +nullDoes the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the tool read-only, idempotent, and non-destructive, so the description does not need to repeat those. It does add a small behavioral detail — that the index is scoped to the suburb's postcode area — but says nothing about the index's calculation, scale, or interpretation.
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 sentence with no filler or repetition. It front-loads the core concept and avoids any unnecessary detail, making it easy for an agent to parse quickly.
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 read-only lookup with one required parameter and no output schema, the description gives enough to call the tool, but it leaves the actual meaning and format of the affordability index unspecified. It is adequate but not complete, especially given the large sibling family where more explicit differentiation 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, but the single parameter is named suburb_name and the description references 'suburb's postcode area', making the parameter's role reasonably clear. However, it adds no format, example values, or input constraints beyond what the property name already implies.
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 identifies a specific metric — the Microburbs affordability index — and the scope (suburb's postcode area). This clearly distinguishes it from sibling market tools focused on price, rent, or supply, though it does not explicitly name alternatives.
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 provides no guidance on when to use this tool versus the many related suburbs_market_* and suburbs_hero_* tools. Usage must be inferred entirely from the name and terse description, with no mention of conditions, prerequisites, or alternatives.
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.