Skip to content

list_rooms

List the rooms on a unit or unit type. Returns roomId, position, and room type details for each room. Use the roomId when calling add_beds or set_beds.

Parameter Type Required Description
entityType EntityType Yes The type of entity to list rooms for (UNIT or UNIT_TYPE — rooms do not apply to buildings) - EntityType
entityId string Yes The ID of the unit or unit type
Value Description
UNIT A single accommodation unit
UNIT_TYPE A unit type grouping multiple 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