vivado_generate_bitstream

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

With no annotations, the description must cover behavior. It states the action but omits side effects (e.g., file writes), resource usage (e.g., time, disk), or whether it modifies the project. The timeout parameter hints at long duration but this is not disclosed.

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?

The description is extremely brief (4 words) but at the expense of essential information. It is not well-structured for usability; a slightly longer description with key details would improve it.

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?

Despite having an output schema, the description does not explain return values or success conditions. For a 4-parameter tool with no annotation support, the description lacks critical context for correct invocation.

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 coverage is 0%; the description adds no meaning to any of the 4 parameters (session_ref, run_name, jobs, timeout_seconds). The agent must infer their purpose from names alone, which is insufficient.

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 'Run implementation through write_bitstream' clearly specifies the tool performs implementation and bitstream generation, distinguishing it from siblings like vivado_run_implementation which only runs implementation. However, it could be more explicit about the composite nature.

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 tool versus alternatives like vivado_run_implementation or prerequisites. An agent has no context on whether synthesis must precede this step or what scenarios avoid using this tool.

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