ptv_repairFault

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

No annotations are present, so the description must disclose behavioral traits. It mentions 'generate or apply' but does not explain that applying repair commands may modify network state (destructive), nor does it describe the output format or error conditions.

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), which is efficient but sacrifices clarity. It uses 'or' to cover two modes, but could be more structured to explain the dual behavior.

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 3 parameters with no schema descriptions, no output schema, and no annotations, the description is severely incomplete. It fails to explain the relationship with fault library, the role of prefix, or the result of apply=true.

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?

With 0% schema description coverage, the description adds no meaning to the parameters: faultId (source of fault IDs?), prefix (purpose?), apply (what does true/false mean?). Schema itself also lacks descriptions.

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 tool generates or applies repair commands for a built-in fault scenario, which distinguishes it from sibling tools like injectFault (injects faults) and getFaultLibrary (lists faults). However, it could be more specific about what 'built-in fault scenario' means.

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 on when to use this tool vs alternatives such as ptv_injectFault or ptv_getFaultLibrary. The description does not mention prerequisites, when to generate vs apply, or typical use cases.

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