ethercat_slaves

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

Annotations declare readOnlyHint=true and destructiveHint=false. Description adds '[READ][risk=low]' and details return dict structure, example call. It does not contradict annotations and provides useful behavioral context beyond them.

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?

Description is extremely concise: two-sentence intro, then clear Args/Returns/Example sections. No wasted words, front-loaded with key info.

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, parameter, return structure (with fields), and example. For a simple enumeration tool with no output schema, this is sufficient. Lacks details on possible slave states but acceptable.

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 0% description coverage, so description must compensate. It defines 'endpoint: Endpoint name from config (protocol "ethercat").' This adds meaning beyond schema (just 'string' with default null), clarifying the parameter's source and protocol constraint.

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?

Description starts with '[READ][risk=low] Bus scan: enumerate every slave on the segment.' This clearly states a read operation to enumerate all slaves, with specific verb 'enumerate' and resource 'slaves'. It distinguishes from sibling tools like 'ethercat_slave_info' (specific slave) and 'ethercat_master_state' (master state).

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?

Description implies usage as a general bus scan but does not explicitly state when to use this tool versus alternatives like 'ethercat_slave_info' or 'ethercat_master_state'. No guidance on when not to use it.

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