vivado_check_installation

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

No annotations are provided, so the description must carry full burden. It only states 'Find Vivado and return its version' without disclosing what happens if Vivado is not found, how it locates the installation, or any side effects. This is insufficient for an agent to understand expected behavior.

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 very short (one sentence) and front-loaded, but it sacrifices detail for brevity. It could be longer to cover essential information without being verbose. Score reflects adequate conciseness but insufficient completeness.

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 that there is an output schema, the description could be shorter, but it still fails to mention what the output contains (e.g., version string), error cases, or whether the tool searches common paths. It is incomplete for a simple check tool.

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%, meaning no parameter descriptions in the schema. The description does not explain the 'vivado_path' parameter at all, beyond what the schema provides (type and default). An agent has no guidance on what value to provide or its purpose.

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 clearly states the verb 'Find' and the resource 'Vivado' and its version. This distinguishes it from sibling tools like vivado_create_project or vivado_run_synthesis, which are about project creation or running tasks. The purpose is unambiguous.

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?

The description gives no explicit guidance on when to use this tool vs alternatives. However, its name and simple purpose imply it's for checking if Vivado is installed and retrieving its version. It lacks instructions on prerequisites or when not to use it.

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