entity-lookup-tool
Look up specific devices by their UUIDs to get exact device states, licenses, and features. Filter results to limit response size and include only needed data.
Instructions
Retrieves specific entities (or devices) by their UUIDs. Takes a list of device UUIDs and returns the device information for those specific devices. Use this tool when the user asks for details on devices' states and details about their licenses and features. The return structure is a JSON object that contains the states of the requested entities. This data is exact. Only devices with matching UUIDs will be returned.
Output filtering (all tools):
includeFields(string[]): Dot-notation paths to keep in the response (e.g."vehicleEvents.vehicleLicensePlate"). Omit to return all fields.filterBy(array): Predicates to filter array items. Each entry:{field, op, value}where op is one of= != > >= < <= contains. All conditions are ANDed. Example:[{field:"vehicleLicensePlate", op:"=", value:"ABC123"}]WARNING: some tool responses exceed 400k characters — use these params to request only the data you need.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deviceUuids | Yes | The UUIDs of the devices to look up. | |
| timeZone | Yes | The timezone for formatting timestamps. This is necessary for the tool to produce accurate formatted timestamps. | |
| tempUnit | Yes | The unit of temperature to return, if applicable. Default is Celsius. | |
| includeFields | Yes | Dot-notation field paths to include in the response (e.g. "vehicleEvents.vehicleLicensePlate"). Pass null to return all fields. WARNING: some responses can exceed 400k characters — use includeFields to request only the data you need. For high-volume tools this may be required to get a complete answer. | |
| filterBy | Yes | Filter array items in the response by field values. All conditions are ANDed. Example: [{field: "vehicleLicensePlate", op: "=", value: "ABC123"}, {field: "confidence", op: ">", value: 0.8}] Use alongside includeFields to get only the specific records and fields you need. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cameras | No | List of cameras matching the provided UUIDs | |
| camerasCount | No | Number of cameras found | |
| doorbellCameras | No | List of doorbell cameras matching the provided UUIDs | |
| doorbellCamerasCount | No | Number of doorbell cameras found | |
| badgeReaders | No | List of badge readers matching the provided UUIDs | |
| badgeReadersCount | No | Number of badge readers found | |
| accessControlledDoors | No | List of access controlled doors matching the provided UUIDs | |
| accessControlledDoorsCount | No | Number of access controlled doors found | |
| audioGateways | No | List of audio gateways matching the provided UUIDs | |
| audioGatewaysCount | No | Number of audio gateways found | |
| doorStates | No | List of door sensors matching the provided UUIDs | |
| doorStatesCount | No | Number of door sensors found | |
| climateStates | No | List of environmental sensors matching the provided UUIDs | |
| climateStatesCount | No | Number of environmental sensors found | |
| occupancySensorStates | No | List of motion sensors matching the provided UUIDs | |
| occupancySensorStatesCount | No | Number of motion sensors found | |
| buttonStates | No | List of buttons matching the provided UUIDs | |
| buttonStatesCount | No | Number of buttons found | |
| keypadStates | No | List of keypads matching the provided UUIDs | |
| keypadStatesCount | No | Number of keypads found | |
| minimalEnvironmentalGatewayStates | No | List of environmental gateways matching the provided UUIDs | |
| minimalEnvironmentalGatewayStatesCount | No | Number of environmental gateways found | |
| error | No | An error message if the request failed. |