Skip to main content
Glama

Microburbs Australian Property Data

Area Statistics · Search area-statistics fields

area_stats_fields
Read-onlyIdempotent

Discover which statistical fields exist. Free (0c). Fuzzy, token-based matching covers table topics and clean column labels as well as terse field codes. Common natural-language plurals and synonyms are handled, so the verbatim query=couples with children discovers the exact 2021 family-composition count fields rather than substituting the broader census_family_households metric. Use the returned field code(s) with the priced /area-stats/SAL/{suburb}/values route. ~17k fields available.

Free.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "area_stats_fields"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMax fields to return.
queryNoFuzzy search over field names/codes, table topics and column labels (e.g. 'total population', 'couple family children', 'tenure owned outright', or 'median rent'). Omit to list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / query / description
      Previous value: -"Fuzzy search over ABS field names/codes, table topics and column labels (e.g. 'total population', 'couple family children', 'tenure owned outright', or 'median rent'). Omit to list."New value: +"Fuzzy search over field names/codes, table topics and column labels (e.g. 'total population', 'couple family children', 'tenure owned outright', or 'median rent'). Omit to list."
  2. 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": "A page of matching fields.",
      -          "example": {
      -            "count": 1,
      -            "fields": [
      -              {
      -                "field_code": "Median_rent_weekly",
      -                "field_name": "Median rent weekly",
      -                "label": "Median rent ($/weekly)",
      -                "topic": "Selected Medians and Averages"
      -              }
      -            ]
      -          },
      -          "properties": {
      -            "count": {
      -              "description": "Number of fields returned.",
      -              "title": "Count",
      -              "type": "integer"
      -            },
      -            "fields": {
      -              "description": "Matching fields, best match first.",
      -              "items": {
      -                "additionalProperties": true,
      -                "description": "One statistical field in the catalog.",
      -                "properties": {
      -                  "field_code": {
      -                    "description": "Stable field identifier — pass this to /values (e.g. 'Median_rent_weekly').",
      -                    "title": "Field Code",
      -                    "type": "string"
      -                  },
      -                  "field_name": {
      -                    "description": "Human-readable field name (e.g. 'Median rent weekly').",
      -                    "title": "Field Name",
      -                    "type": "string"
      -                  },
      -                  "label": {
      -                    "anyOf": [
      -                      {
      -                        "type": "string"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ],
      -                    "description": "Clean column label for the field (e.g. 'Couple family with no children').",
      -                    "title": "Label"
      -                  },
      -                  "topic": {
      -                    "anyOf": [
      -                      {
      -                        "type": "string"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ],
      -                    "description": "Subject of the source table — the context for cross-tab fields (e.g. 'Mortgage Repayment (Monthly) by Family Composition').",
      -                    "title": "Topic"
      -                  }
      -                },
      -                "required": [
      -                  "field_code",
      -                  "field_name"
      -                ],
      -                "title": "AreaStatField",
      -                "type": "object"
      -              },
      -              "title": "Fields",
      -              "type": "array"
      -            }
      -          },
      -          "required": [
      -            "count",
      -            "fields"
      -          ],
      -          "title": "AreaStatFieldsResponse",
      -          "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[AreaStatFieldsResponse]",
      -  "type": "object",
      -  "x-fastmcp-top-level-schema": "ApiResponse_AreaStatFieldsResponse_"
      -}New value: +null
  3. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and closed-world, so the safety profile is covered. The description adds genuinely new context: zero cost (0c), fuzzy token-based matching behavior, plural/synonym handling, and the ~17k field population size. It says nothing about result ordering, pagination across 17k fields, or what happens when no match is found.

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?

Front-loads the core purpose and the free-cost signal, then layers matching behavior and the next-step route. The only waste is the duplicated cost statement ('Free (0c)' at the start and '**Free.**' at the end), which repeats information already given.

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?

With no output schema, the description adequately signals that the return is field code(s) usable downstream, and it discloses the corpus size. Given 17k fields and a 50-default/500-max limit, it could say more about narrowing results or refining queries, but nothing essential for a correct call is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description earns above it by explaining the matching semantics of `query` (fuzzy, token-based, plural/synonym aware, matches table topics and column labels, not just codes). The worked example shows verbatim phrasing resolves to the exact field rather than a broader metric, which is meaningful beyond the schema's own examples.

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?

States a specific verb and resource ('Discover which statistical fields exist') and implicitly scopes it as the lookup step ahead of the priced values route. An agent can distinguish it from area_stats_regions (region listing) and area_stats_values (value retrieval) without opening a schema.

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?

Explicitly tells the agent to feed returned field codes into the priced `/area-stats/SAL/{suburb}/values` route, which establishes the use-then-call ordering against a sibling. It also notes 'Omit to list' for parameterless discovery. It stops short of naming area_stats_values directly or saying when the fuzzy matcher is the wrong approach versus a direct lookup.

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