List all available amenity reference data. Returns amenityId, key (SCREAMING_SNAKE_CASE reference, e.g. “WIFI”), and
category for each amenity. Pass entityType to scope the list to amenities supported on a UNIT_TYPE or BUILDING. Use the
returned amenityId when calling add_amenities, set_amenities, or remove_amenities.
The full catalogue is returned in a single call: the tool follows GraphQL connection cursors server-side until the
catalogue is exhausted, then returns a flat array.
| Parameter |
Type |
Required |
Description |
entityType |
EntityType |
No |
Optional entity type to scope the list. UNIT_TYPE returns the amenities supported on unit types; BUILDING returns the amenities supported on buildings; omit (or pass UNIT) to return every amenity. - EntityType |
| Value |
Description |
UNIT |
A single accommodation unit |
UNIT_TYPE |
A unit type grouping multiple units |
BUILDING |
A building containing unit types and units |
| Field |
Type |
Description |
content |
ContentItem[] |
Array of content items returned by the tool - ContentItem |
isError |
boolean |
Whether the tool execution resulted in an error |
| Field |
Type |
Description |
type |
'text' |
Content type (currently only ‘text’ is supported) |
text |
string |
The text content to display |
The text field contains a JSON-encoded array of amenities, each with the shape:
| Field |
Type |
Description |
amenityId |
string |
The amenity ID. Pass this to add_amenities, set_amenities, or remove_amenities. |
key |
string |
The SCREAMING_SNAKE_CASE reference, e.g. WIFI, OVEN, SMOKE_ALARM. |
category |
string |
The amenity category, e.g. BASIC, KITCHEN, SAFETY_AND_ACCESS, ADDITIONAL, PLATFORM_SPECIFIC. |