Lists a building’s or unit types’ units with the attributes building rate modifiers match on (floor,
orientation, zone, size), 25 per page sorted by unit code. Follow nextPageArgs to read every unit.
| Parameter |
Type |
Required |
Description |
buildingId |
string |
No |
Only return units in this building. Give buildingId, unitTypeIds, or both. |
unitTypeIds |
string[] |
No |
Only return units of these unit types. Give buildingId, unitTypeIds, or both. |
code |
string |
No |
Filter by unit code. A plain value matches codes containing it; prefix with ^ for starts-with. |
first |
number |
No |
Number of units to return (forward pagination). Maximum 25. Use with “after” for paging. |
after |
string |
No |
Cursor for forward pagination. Pass the “endCursor” from previous page’s pageInfo. |
| 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 |
