shelly_virtual_list

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

Annotations already declare readOnlyHint=true, so the agent knows it is a safe read operation. The description adds that it uses Shelly.GetComponents and targets virtual (dynamic) components, which provides some additional context but does not reveal other behavioral traits like error handling or response structure.

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 extremely concise at one sentence, which is efficient for a simple tool. However, it lacks any structure (e.g., no examples or parameter details) that could improve readability without adding much length.

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 an output schema (not provided but stated in context) and only one parameter, the description is minimally adequate. However, it fails to explain the parameter or provide usage context, leaving gaps for an agent unfamiliar with the Shelly domain.

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 only parameter 'device' has no description in the schema (0% coverage). The description does not explain what 'device' refers to (e.g., device ID, name, or IP). It simply restates the method name, adding no clarity beyond the schema.

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 it lists virtual (dynamic) components via a specific method (Shelly.GetComponents). It distinguishes from sibling tools like shelly_list_components by focusing on virtual components, but could be slightly clearer on what constitutes a virtual component.

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?

No guidance on when to use this tool versus alternatives. There are siblings like shelly_list_components, shelly_get_status, and shelly_get_config, but the description provides no context for selecting this tool over them.

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