assign_bd_address

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

No annotations are provided, so the description carries the full burden. It does not say that this mutates the block design, that it is effectively an all-or-nothing operation over every addressable interface, whether existing manual address assignments are overwritten, or that a BD must be open with connected cells. With zero parameters, 'auto' implies no targeting, but nothing confirms the side effects.

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?

One short sentence, front-loaded with the action. The trailing parenthetical duplicating the tool name is wasted characters but the overall length is appropriate.

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?

A state-mutating, zero-argument block-design operation with no annotations and no output schema needs at least prerequisites (open BD, existing cells/connections) and a note on what changes. The description supplies neither, leaving the agent unable to predict or verify the effect.

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 tool takes zero parameters, so per convention the baseline is 4. The description does not need to explain parameter meaning, though it could have made the implicit 'no arguments = all interfaces' contract explicit.

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 names a verb (auto-assign) and resource (addresses in the BD address editor), but the parenthetical '(assign_bd_address)' simply restates the tool name, and 'BD address editor' is only marginally more context than the name itself. It is more than a pure tautology but not a clean, specific statement of what gets assigned (slave segments, memory ranges) or to what.

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?

There is no guidance on when to use this versus adjacent BD tools such as auto_connect_axi, connect_bd_net, connect_bd_intf_net, or configure_bd_cell. An agent must guess that this is the post-connection step to run after wiring a BD with addressable interfaces.

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