ioc_compare

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

With no annotations, the description carries the burden, and it does disclose the underlying mechanism (CubeMX's own differ via cpload + cpexport) and that output is report text. It says nothing about side effects such as writing a report file to disk, opening a view, or whether project state is modified — significant gaps for an unannotated 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?

A single front-loaded sentence with no filler; the parenthetical implementation detail is marginal but does contribute to behavioral understanding. Nothing is wasted, though nothing is expanded either.

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 7-parameter, unannotated, no-output-schema tool, the description covers purpose and return type but leaves optional-parameter behavior (omitting ioc_2, what open_view does, report file location, timeout semantics) unexplained. Adequate but with clear gaps.

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 100%, so the schema already documents all seven parameters and the baseline is 3. The description only loosely hints at the two-project mapping (cpload project1/2) and adds no format or defaulting 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?

States a specific verb (compare) and resource (.ioc files) and adds that the result is the report text, so the agent knows what it gets back. It does not differentiate itself from the sibling project_diff, which sounds like it could cover a similar need.

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 statement of when to prefer this over project_diff, ioc_get, or ioc_export, and no prerequisites (e.g., whether the project must be open or CubeMX/CLI available). The agent must infer selection from the name alone.

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