Manage OpenVPN Server

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

Annotations already mark it as destructive and idempotent. The description adds value by disclosing the NOT_FOUND error condition and the singleton nature. It does not elaborate on what exactly gets destroyed or authorization needs, but with annotations, the description provides adequate additional context.

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 with three sentences, each earning its place: purpose, error condition, and constraint. No fluff, and the key information is front-loaded.

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 the tool's complexity (10 parameters, multiple actions, error states), the description covers the basics but lacks details like the effects of enable/disable, whether set modifies or overwrites, and what the return value is (no output schema). The dryRun and confirmationToken parameters are not mentioned, though they appear in the schema.

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 baseline is 3. The description mentions that the 'set' action requires at least one configuration field, but this is already implied by the schema. It does not add further semantics beyond what the schema provides, such as format constraints or dependencies between parameters.

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 enables, disables, or configures the OpenVPN server, specifying it is a per-router singleton. It distinguishes from sibling tools like get_ovpn_server (read-only) and manage_ovpn_client (client management).

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 clear guidance: it mentions the possible actions and that 'set' requires at least one configuration field. It also warns of a NOT_FOUND error if the package is not installed. However, it does not explicitly suggest using list_packages or get_ovpn_server first, nor does it describe when to use enable/disable versus set.

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