cocotb_generate_runner

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

With no annotations, the description carries the full burden of behavioral disclosure. It mentions the output is 'deterministic' and 'standard', but does not disclose whether the tool writes a file to disk, returns Makefile content, overwrites existing files, or what side effects occur. This is a meaningful transparency gap for a generator tool.

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 a single concise sentence that front-loads the core purpose and includes no filler or redundant phrasing. Every word contributes to the meaning.

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?

There is no output schema and no annotations, so the description should clarify what the caller receives. It is ambiguous whether 'generates' means writing a Makefile to disk or returning its contents, and there is no mention of file paths, overwrite behavior, or the deterministic output's meaning. The description is too thin for a tool an agent must invoke correctly without further 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 description coverage is 100%, so the input schema already documents all four parameters. The description adds the context that the tool targets a Verilog DUT and Python test module, which maps to the parameters, but it does not add deeper semantic detail beyond the schema.

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 specific verb ('Generates'), a specific resource ('Cocotb simulation Makefile'), and key inputs ('Verilog DUT and Python test module'). This clearly differentiates the tool from its siblings like cocotb_run, which would execute simulations rather than create build artifacts.

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 is provided about when to use this tool versus alternatives such as cocotb_run or cocotb_list_tests. The description implies the tool is for producing a Makefile, but it does not state prerequisites, when generation is appropriate, or when another sibling should be chosen.

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