Suburb at a glance
suburbs_hero_summaryState, SA3/SA4, postcode, population, dwellings and centroid for the suburb.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| suburb_name | Yes |
suburbs_hero_summaryState, SA3/SA4, postcode, population, dwellings and centroid for the suburb.
| 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": "Suburb at a glance — geography chain, population, dwellings, centroid.",
- "example": {
- "area_level": "suburb",
- "area_name": "Belmont North",
- "dwellings": 2453,
- "lat": -33.01705,
- "lng": 151.672252,
- "population": 6280,
- "postcode": "2280",
- "sa3": "Lake Macquarie - East",
- "sa4": "Newcastle and Lake Macquarie",
- "state": "New South Wales",
- "state_abbr": "NSW"
- },
- "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"
- },
- "dwellings": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "Total dwellings (sum over the suburb's mesh blocks, ABS Census).",
- "title": "Dwellings"
- },
- "lat": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Latitude of the suburb boundary's centroid.",
- "title": "Lat"
- },
- "lng": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "description": "Longitude of the suburb boundary's centroid.",
- "title": "Lng"
- },
- "population": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "Total population (sum over the suburb's mesh blocks, ABS Census).",
- "title": "Population"
- },
- "postcode": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Postcode (POA) covering the suburb.",
- "title": "Postcode"
- },
- "sa3": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "ABS SA3 region the suburb sits in.",
- "title": "Sa3"
- },
- "sa4": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "ABS SA4 region the suburb sits in.",
- "title": "Sa4"
- },
- "state": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "State / territory full name, e.g. 'New South Wales'.",
- "title": "State"
- },
- "state_abbr": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "State / territory abbreviation, e.g. 'NSW'.",
- "title": "State Abbr"
- }
- },
- "required": [
- "area_name",
- "area_level"
- ],
- "title": "HeroSummary",
- "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[HeroSummary]",
- "type": "object",
- "x-fastmcp-top-level-schema": "ApiResponse_HeroSummary_"
-}New value: +nullDoes the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is well covered. The description adds the concrete output field set but does not disclose matching behavior, response format, units, or any additional behavioral context.
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 one compact sentence that packs the full field list with no filler or redundancy. It is appropriately short for a simple overview tool, though adding a verb would make it slightly more grammatical.
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?
Given the simple one-parameter schema and read-only annotations, the description gives a reasonable overview by listing the output fields. However, there is no output schema and no usage guidance, so an agent lacks clarity on the exact response shape and how this tool relates to the many other suburbs_* summary tools.
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%, and the description does not explain the required suburb_name parameter, its format, case-sensitivity, or how duplicate suburb names are handled. The property name is self-evident, but the description provides no parameter-level guidance to compensate for the missing schema descriptions.
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 clearly enumerates the fields the tool returns: State, SA3/SA4, postcode, population, dwellings, and centroid, and the title 'Suburb at a glance' reinforces an overview purpose. It lacks an explicit verb and does not explicitly distinguish itself from similar siblings like suburbs_profile or suburbs_market_all.
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?
There is no guidance on when to use this tool instead of alternatives such as suburbs_profile, suburbs_market_all, or suburbs_finder_*. The title implies a quick overview, but no when-to-use or when-not-to-use conditions are stated.
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.