pvsyst_compare_components

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

No annotations are provided, so the description carries full disclosure burden, yet it never says whether the operation is read-only, whether it mutates anything, what "bounded" means in practice (size limits, truncation), or what the result looks like. "Binary PAN hashes" hints at an opaque hash comparison rather than a field-level diff, but that is left for the agent to guess.

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 compact sentence with the resource and both modes front-loaded; nothing is redundant. It is arguably too terse for the complexity involved, but no sentence is wasted.

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?

Given four undocumented parameters, no annotations, and no output schema, the definition leaves major open questions (parameter meaning, result shape, side effects, limits). The two-mode framing is the only substantive content; for a comparison tool with this many unknowns, more is required.

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 0% and description adds almost nothing: it never explains `first`/`second` (paths? names? IDs?), what values `component_type` accepts, or — most importantly — what `second_library` (default "workspace") means, which implies components can be sourced from different libraries. Only the "same-type" constraint loosely maps to `component_type`.

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?

Uses a specific verb+resource ("Compare two ... components") and adds the key constraint that both must be the same type, plus the two comparison modes (text diff vs binary PAN hashes). It is distinguishable from siblings like pvsyst_get_component or pvsyst_validate_component, though it never frames itself against them.

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 use this versus pvsyst_get_component, pvsyst_validate_component, or pvsyst_compare_engineering_scenarios (a similarly named sibling). The only implicit guidance is the "same-type" constraint. An agent must infer the use case 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.