get_vpn_user

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

With no annotations, the description should disclose behavioral traits. It only mentions error codes but does not clarify side effects, authentication needs, or output structure. The tool is likely read-only, but this is not confirmed.

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 very short (two sentences) and front-loaded with the purpose. The error code list is somewhat extraneous but not verbose. Could be improved by removing error codes to a separate field if needed.

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 no parameters and an output schema, the description is minimally adequate. However, it lacks context about what a VPNUser is, how the list is ordered, or any filtering capabilities. More context would help in a toolset with many siblings.

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 tool has zero parameters, so the input schema is fully covered. The description adds no extra parameter meaning, but the baseline for no parameters is 4. The phrase 'list of VPNUser' implies multiple users, which is slightly informative.

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 'Get the list of VPNUser', which indicates a retrieval operation but is vague (e.g., does it return all users or a specific subset?). It does not differentiate from sibling tools like get_vpn_user_login or get_vpn_client_config, which also involve VPN users.

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 alternatives. The description lacks any context of prerequisites, typical use cases, or exclusions. The error code list is not usage guidance.

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