Skip to main content
Glama

Microburbs Australian Property Data

by au.com.microburbs
OverviewDiscussionsAdmin

Area statistics for a region

area_stats_values
Read-onlyIdempotent

Statistical field values for one region. Pass fields — 1 to 5 field codes (from /fields) — to fetch.

At SAL level, mode=sa1 switches from the suburb-aggregate value to a per-SA1 breakdown — every SA1 that falls inside the suburb, each with its own values.

Price: 3¢ per call.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoSAL only: 'sa1' returns values for every SA1 in the suburb, instead of the suburb aggregate.
fieldsYesComma-separated field codes (from /fields). Required, 1-5 per call.
regionYesRegion name (case-insensitive). For SA1, the SA1 code (SA1s are unnamed).
region_levelYesRegion level: SAL (suburb), SA1, SA2, SA3, SA4, LGA, POA, GCCSA, STE, AUS.

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": [
-        {
-          "description": "Statistical field values for one region.\n\nDefault: `fields` holds the region's values. At SAL level with `mode=sa1`,\n`fields` is omitted and `sa1s` holds a per-SA1 breakdown instead.",
-          "example": {
-            "fields": [
-              {
-                "field_code": "Median_rent_weekly",
-                "field_name": "Median rent weekly",
-                "label": "Median rent ($/weekly)",
-                "topic": "Selected Medians and Averages",
-                "value": 656
-              }
-            ],
-            "region_code": "11303",
-            "region_level": "SAL",
-            "region_name": "Bondi",
-            "year": 2021
-          },
-          "properties": {
-            "fields": {
-              "anyOf": [
-                {
-                  "items": {
-                    "additionalProperties": true,
-                    "description": "One field value for a region.",
-                    "properties": {
-                      "field_code": {
-                        "anyOf": [
-                          {
-                            "type": "string"
-                          },
-                          {
-                            "type": "null"
-                          }
-                        ],
-                        "description": "Stable field identifier.",
-                        "title": "Field Code"
-                      },
-                      "field_name": {
-                        "anyOf": [
-                          {
-                            "type": "string"
-                          },
-                          {
-                            "type": "null"
-                          }
-                        ],
-                        "description": "Human-readable field name (e.g. 'Median rent weekly').",
-                        "title": "Field Name"
-                      },
-                      "label": {
-                        "anyOf": [
-                          {
-                            "type": "string"
-                          },
-                          {
-                            "type": "null"
-                          }
-                        ],
-                        "description": "Clean column label for the field.",
-                        "title": "Label"
-                      },
-                      "topic": {
-                        "anyOf": [
-                          {
-                            "type": "string"
-                          },
-                          {
-                            "type": "null"
-                          }
-                        ],
-                        "description": "Subject of the source table — context for cross-tab fields.",
-                        "title": "Topic"
-                      },
-                      "value": {
-                        "anyOf": [
-                          {
-                            "type": "number"
-                          },
-                          {
-                            "type": "null"
-                          }
-                        ],
-                        "description": "Field value for the region.",
-                        "title": "Value"
-                      }
-                    },
-                    "title": "AreaStatValueRow",
-                    "type": "object"
-                  },
-                  "type": "array"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Field values for the region (default mode).",
-              "title": "Fields"
-            },
-            "mode": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "'sa1' when this is a per-SA1 breakdown of a suburb.",
-              "title": "Mode"
-            },
-            "region_code": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Region code.",
-              "title": "Region Code"
-            },
-            "region_level": {
-              "description": "Region level (SAL, SA1-4, LGA, POA, …).",
-              "title": "Region Level",
-              "type": "string"
-            },
-            "region_name": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Region name (the SA1 code for SA1 — SA1s are unnamed).",
-              "title": "Region Name"
-            },
-            "sa1_count": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Number of SA1s in the suburb (mode=sa1).",
-              "title": "Sa1 Count"
-            },
-            "sa1s": {
-              "anyOf": [
-                {
-                  "items": {
-                    "additionalProperties": true,
-                    "description": "Values for one SA1 within a suburb (mode=sa1).",
-                    "properties": {
-                      "fields": {
-                        "description": "Field values for this SA1.",
-                        "items": {
-                          "additionalProperties": true,
-                          "description": "One field value for a region.",
-                          "properties": {
-                            "field_code": {
-                              "anyOf": [
-                                {
-                                  "type": "string"
-                                },
-                                {
-                                  "type": "null"
-                                }
-                              ],
-                              "description": "Stable field identifier.",
-                              "title": "Field Code"
-                            },
-                            "field_name": {
-                              "anyOf": [
-                                {
-                                  "type": "string"
-                                },
-                                {
-                                  "type": "null"
-                                }
-                              ],
-                              "description": "Human-readable field name (e.g. 'Median rent weekly').",
-                              "title": "Field Name"
-                            },
-                            "label": {
-                              "anyOf": [
-                                {
-                                  "type": "string"
-                                },
-                                {
-                                  "type": "null"
-                                }
-                              ],
-                              "description": "Clean column label for the field.",
-                              "title": "Label"
-                            },
-                            "topic": {
-                              "anyOf": [
-                                {
-                                  "type": "string"
-                                },
-                                {
-                                  "type": "null"
-                                }
-                              ],
-                              "description": "Subject of the source table — context for cross-tab fields.",
-                              "title": "Topic"
-                            },
-                            "value": {
-                              "anyOf": [
-                                {
-                                  "type": "number"
-                                },
-                                {
-                                  "type": "null"
-                                }
-                              ],
-                              "description": "Field value for the region.",
-                              "title": "Value"
-                            }
-                          },
-                          "title": "AreaStatValueRow",
-                          "type": "object"
-                        },
-                        "title": "Fields",
-                        "type": "array"
-                      },
-                      "region_code": {
-                        "description": "SA1 code.",
-                        "title": "Region Code",
-                        "type": "string"
-                      }
-                    },
-                    "required": [
-                      "region_code",
-                      "fields"
-                    ],
-                    "title": "AreaStatSa1",
-                    "type": "object"
-                  },
-                  "type": "array"
-                },
-                {
-                  "type": "null"
-                }
-              ],
-              "description": "Per-SA1 values (mode=sa1).",
-              "title": "Sa1S"
-            },
-            "year": {
-              "default": 2021,
-              "description": "Reference year.",
-              "title": "Year",
-              "type": "integer"
-            }
-          },
-          "required": [
-            "region_level"
-          ],
-          "title": "AreaStatValues",
-          "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[AreaStatValues]",
-  "type": "object",
-  "x-fastmcp-top-level-schema": "ApiResponse_AreaStatValues_"
-}New value: +null
  2. First observed

TDQS

A4/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 the safety profile. The description adds the mode=sa1 behavior (per-SA1 breakdown) and the price per call, which are useful behavioral details beyond the annotations. It doesn't contradict annotations, but it doesn't disclose error handling or rate limits either.

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 three sentences, front-loaded with the purpose, and each sentence earns its place: the core function, the special mode behavior, and the price. No fluff or redundancy.

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?

Given the tool's simplicity and the schema covering all parameters, the description is complete enough. It explains the key behavioral switch (mode=sa1) and includes pricing, which is relevant context. Without an output schema, the description still clarifies that it returns 'statistical field values' for a region, which is sufficient for an agent to call it correctly.

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 description coverage is 100% and all parameters have detailed descriptions (e.g., fields: 'Comma-separated field codes (from /fields). Required, 1-5 per call.'). The description repeats this constraint and the mode behavior, but adds no new parameter semantics beyond the schema. Baseline 3 is appropriate when the schema carries the load.

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 states a specific resource ('statistical field values for one region') and a clear action (fetch by passing fields). It distinguishes from sibling tools like area_stats_fields and area_stats_regions, which likely list fields or regions rather than values. The name and title reinforce this.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly implies when to use it: when you need statistical field values for a region. It also explains the special mode=sa1 for SAL level, giving context on a specific use case. It does not explicitly exclude alternatives or mention when not to use it, but the purpose is clear enough for an agent to select it appropriately.

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