describe_signal

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

No annotations provided, so description carries full burden. Explains what information is retrieved (type, width, direction) but lacks safety disclosure (read-only nature) and error handling (behavior if signal path is invalid).

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 with zero wasted words. Two-sentence structure front-loads purpose and documents the single parameter efficiently despite schema limitations.

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?

Adequate for a single-parameter inspection tool. Presence of output schema means return values don't need description. Covers essential domain concept (hierarchical paths) but misses safety/error context.

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. Description compensates by specifying signal parameter requires 'Full hierarchical signal path', providing essential context for HDL/simulator environments that schema lacks.

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?

States specific action (Get detailed information) and resource (signal), with helpful parenthetical specifying what details (type, width, direction). Implicitly distinguishes from get_signal_value (current value) and list_signals (enumeration), though explicit comparison would strengthen it.

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 versus siblings like get_signal_value or list_signals. Does not mention prerequisites such as requiring an active simulation connection.

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