get_vpn_server

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

No annotations are provided, so the description must carry the behavioral disclosure burden. 'Get' signals a read-only operation, but the description does not mention required permissions, error behavior, or what part of the configuration is returned. The presence of an output schema mitigates return-value ambiguity.

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 front-loaded with the main purpose in the first sentence, followed by compact, useful parameter notes. There is no filler, redundancy, or unnecessary detail.

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?

All three required parameters are semantically covered, and an output schema exists to document return values. The main gap is the absence of a pointer to list_vpn_servers when the server_id is unknown, but this is a minor completeness issue for a simple getter.

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?

The schema has 0% description coverage, and the description compensates by explaining all three parameters: host as console name/ID/composite ID with MAC:numericId format, site as name/ID, and server_id as the VPN server ID. Only server_id is somewhat tautological, but the overall compensation is strong.

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 states a specific verb ('Get'), a clear resource ('single VPN server configuration'), and a selection criterion ('by ID'). This distinguishes it from broader operations such as list_vpn_servers without ambiguity.

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 implies usage: use this tool when you need one VPN server config by ID. However, it does not explicitly say when to use this versus list_vpn_servers or mention prerequisites like how to obtain the server_id.

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