Download HTB VPN Config

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

Annotations already declare readOnly/idempotent/openWorld, so the key addition is behavioral: the call writes a file to a default path and the user must connect themselves. That 'does NOT run OpenVPN' note is exactly the kind of side-effect clarification annotations do not carry.

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?

Three tight sentences, front-loaded with the download action, then defaults, then the critical caveat about not launching OpenVPN. No waste.

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?

With no output schema, the description usefully explains where the file lands and what variant means, which is enough for a simple download tool. Lacks any note on error behavior for an invalid server identifier, which would round it out.

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% and all three params are documented in-schema, so the baseline is 3. The description restates the defaults (lab-vpn.ovpn, variant 0 = UDP) without adding format or syntax detail beyond the schema.

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?

States a specific verb and resource ('Download an OVPN config file') and names the three accepted server identifier forms (id, alias, live name). An agent can distinguish this from htb_vpn_servers (listing) and htb_vpn_switch (switching) without opening the schema.

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?

Gives useful context about the default output location and that the toolkit does not run OpenVPN, but never says when to use this versus htb_vpn_servers (to discover a server) or htb_vpn_switch. Usage is implied rather than stated.

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