update_device

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

The description indicates that this tool modifies device metadata but does not clarify whether updates are partial (only provided fields) or full replacements. It also omits any discussion of side effects, permissions, or idempotency. With no annotations, the description carries full burden but only meets a basic level.

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 concise and well-structured with a one-line summary, separate sections for Args, Returns, and an Example. Every part adds value, and the example illustrates typical usage without excess.

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?

For a simple update tool with an output schema described, the description covers purpose, all parameters, return structure, and usage example. Missing are error conditions, partial vs full update behavior, and prerequisites (e.g., device existence). Still, it is quite complete.

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 description provides meaningful explanations for all five parameters in the Args block (e.g., 'adom: ADOM name', 'device: Device name', 'description: New device description', 'latitude: GPS latitude for device location', 'longitude: GPS longitude for device location'), fully compensating for the 0% schema description coverage.

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 'Update device properties' and elaborates with 'Modify device metadata like description and location.' This specific verb+resource combination distinguishes it from siblings such as add_device, delete_device, and get_device.

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 is provided on when to use this tool versus alternatives like update_address or other update tools. There is no mention of prerequisites, conditions, or exclusions.

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