set_ratsnest_display

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

No annotations provided and description lacks behavioral details such as persistence, side effects, or redraw behavior. Leaves agent guessing about impact beyond immediate setting.

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?

Extremely concise: two sentences with no unnecessary words. Front-loaded with action and immediate clarification.

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 one-parameter tool with no output schema, description is nearly complete. Could mention scope (e.g., affects current board) but not essential.

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?

Schema has no description coverage, so description carries full burden. Adds meaning by listing the two allowed values ('all' and 'visible') beyond just type string.

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 the verb 'Set' and the resource 'display mode of ratsnest lines', with explicit choices 'all' or 'visible'. Differentiates from sibling tools like set_active_layer.

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?

Provides clear context for usage by specifying when to use and the two allowed values. No explicit alternatives or when-not-to-use, but not necessary for a simple setting.

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