set_layout_lights

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

Describes that it loops server-side, returns success/failure lists, and catch-and-continue behavior. No annotations provided, so description carries full burden. Could mention potential side effects (e.g., lights are changed), but overall transparent.

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?

Front-loaded with purpose, then args, then context, then return value. Every sentence adds value; no redundancy.

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?

Covers purpose, usage, behavior, and return format. Could mention if any lights are not controllable, but completeness is high for a simple boolean tool.

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?

Only parameter turn_on is fully explained: 'True to turn every layout light ON, False to turn every layout light OFF.' Schema coverage is 0%, so description compensates completely.

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?

Clearly states 'Turn EVERY layout light ON or OFF at once (depot, street, signal lamps — JMRI Light objects)'. Specific verb-resource-scope combination, and distinguishes from sibling tools like set_loco_lights and set_all_locos_lights.

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?

Explicitly says when to use (lighting request not naming a locomotive) and when not to (if request names a locomotive, use set_loco_lights or set_all_locos_lights). Also advises against using set_light in a loop.

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