get_vpn_connection

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

No annotations provided. The description only lists cryptic error codes without explaining behavior, return format, or side effects. Fails to disclose what the tool actually does beyond a vague 'get list'.

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?

Extremely short but lacks clarity. The error code list is unhelpful without context. The description is concise but not informative, violating the principle that every sentence must earn its place.

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?

Despite having an output schema, the description fails to explain the purpose or output. It is incomplete for an agent to correctly understand and invoke the tool, especially given ambiguous phrasing.

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?

No parameters exist, so schema coverage is 100%. The description adds no parameter information, but this is acceptable given zero parameters. However, it misses the opportunity to explain what the tool returns.

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 says 'Get the list of VPNUser', but the tool name is 'get_vpn_connection', creating confusion about whether it returns VPN users or VPN connections. This mismatch undermines purpose clarity.

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 on when to use this tool versus related siblings like get_vpn, get_vpn_client_config, or get_vpn_user. The description provides no context for selection.

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