get_neighborhood_guide

get_neighborhood_guide returns neighborhood information for a listing’s immediate area, extracted from curated local renter-forum research. It covers select major US metros and may take several seconds to return.

When to use it

Use it after search_listings or get_listing when a renter wants to understand what living near a specific listing is like — local character, getting around, what residents say about the area. The guide is descriptive, not a steering tool. Requests that ask about the demographic makeup of an area or otherwise touch protected classes are blocked by Fair Housing guardrails and return FAIR_HOUSING_VIOLATION.

Input

{
  "listing_id": "listing-record-id"
}

Field	Type	Required	Notes
`listing_id`	string	Yes	A listing snapshot id returned by `search_listings`.

Output

{
  "guide_status": "available",
  "coverage": "neighborhood",
  "listing_id": "listing-record-id",
  "city": "Brooklyn",
  "state": "NY",
  "message": null,
  "content": "Park Slope is known for tree-lined blocks, the Prospect Park edge, and...",
  "source": "Curated renter forum research for Brooklyn"
}

Field	Type	Notes
`guide_status`	string	`available` when a guide was found; `no_guide_for_city` when none exists for the listing’s city.
`coverage`	string \| null	When `available`: `neighborhood` means the content is specific to the listing’s immediate area; `city` means no area-specific material was found, so the content is general city-level highlights. `null` when no guide is available.
`listing_id`	string	Echoes the requested id.
`city`	string	The listing’s city (may be empty if none is on record).
`state`	string \| null	The listing’s state, if known.
`message`	string \| null	Set when `guide_status` is `no_guide_for_city`, explaining why; otherwise `null`.
`content`	string \| null	The neighborhood digest when `available`; otherwise `null`.
`source`	string \| null	Provenance line for the content; `null` when no guide is available.

When no guide exists for the city, the tool returns a successful response with guide_status: "no_guide_for_city" and a human-readable message rather than an error. Unknown listing ids return LISTING_NOT_FOUND.

brightplace Connect

Tool Reference

Security and Policy

When to use it

Input

Output

​When to use it

​Input

​Output

When to use it

Input

Output