vunit_compile

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

Annotations already mark idempotentHint=true and readOnlyHint=false; the description adds the simulator requirement and the 'all sources' scope, but does not describe side effects on build artifacts or what happens if the simulator is unavailable. It aligns with idempotency rather than contradicting it.

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?

Two short sentences carry the primary action, scope, prerequisite, and safety property with no filler. Useful information is front-loaded in the first sentence.

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?

For a parameterless tool with an output schema and safety annotations, the description is largely sufficient. It could be stronger by placing the tool in the VUnit workflow (compile before run_tests) and by noting build-artifact side effects, but nothing essential is missing for 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?

The tool has zero parameters and the schema documents 100% of them (none), so the description does not need parameter-level detail. Baseline for zero params applies.

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 the action ('Compile') and the exact scope ('all sources in the VUnit project'), and anchors it to the CLI flag --compile. This is clearly distinct from sibling tools such as list_files, run_tests, and status.

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?

It gives a clear context and prerequisite: the command requires a simulator, and re-running is safe. It does not explicitly contrast with siblings or say when not to use it, but an agent can infer this is the build/pre-step versus run_tests.

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