tb_list_devices

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description must carry the full burden of behavioral disclosure. It says 'list all devices' but the schema includes page and limit parameters, suggesting pagination, which is not mentioned. The read-only nature is implied but not explicit, and there is no information about response behavior or rate limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence that states the core purpose without any wasted words. It is front-loaded and easy to parse, ideal for quick scanning by an agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 3 parameters, no output schema, and no annotations, the description is incomplete. It fails to mention pagination behavior, the requirement to specify a device_id for the target server, and what the return data looks like. The phrase 'list all devices' overpromises given the pagination parameters, which could lead to incorrect usage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema covers 100% of parameters with descriptions, so the baseline is 3. The tool description adds no extra semantics about how page/limit affect the 'all devices' promise or why device_id is required, but it does not need to since the schema is already informative.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool lists all devices registered in ThingsBoard, specifying the platform (ThingsBoard) and the action (list all devices). This distinguishes it from sibling tools for other platforms, such as sonoff_list_devices or dss_list_devices.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for retrieving a device inventory from ThingsBoard, but it does not explicitly state when to prefer this over generic alternatives like iot_list_devices, nor does it mention any exclusions or prerequisites beyond what the schema shows.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.