vyos_generate

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

Annotations indicate non-read-only, non-destructive, non-idempotent, and open-world behavior. The description adds context by stating the return type (generated output or error) and examples of what is generated. There is no contradiction with annotations.

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 concise (4 sentences plus examples) and well-structured with Args, Returns, and Examples sections. The first sentence immediately communicates the tool's purpose.

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?

The description covers purpose, usage guidelines, parameters, and return type. For a simple generate tool with one parameter and an output schema, it provides sufficient context, though error handling could be slightly more detailed.

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?

Although schema description coverage is 0% for the top-level parameter, the description explains 'params: path — generate command path segments' and provides domain-specific examples for generating keys, adding value beyond the generic schema description.

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 runs a VyOS 'generate' command for generating cryptographic keys, certificates, and other system components. It uses a specific verb ('generate') and resource, distinguishing it from sibling tools like vyos_set or vyos_delete.

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 provides concrete examples (WireGuard keypair, OpenVPN keys) and states the general use case. It does not explicitly mention when not to use the tool or contrast with siblings, but the examples offer clear guidance.

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