get_vpn_client_config

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

No annotations are provided, so the description carries the full burden. It only says 'Get the list' and lists error codes. It does not disclose safety (read-only is implied but not explicit), any side effects, or other behavioral traits. The error code list is unhelpful without context. Score 2 (minimal disclosure).

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 two sentences. The first sentence is concise. The second sentence is a long list of error codes that does not help with tool selection or invocation. It adds noise without explanation. This is not earnestly concise; the list could be omitted or summarized. Score 3 (some 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?

Given that there is an output schema (not shown) and no parameters, the description is still incomplete. It does not define what a VPNClientConfig is or clarify that this tool lists multiple configs (as opposed to get_vpn_client_config_id). The error code list is vague. Overall, it lacks essential context for an agent to use it correctly. Score 2 (minimal completeness).

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, and the input schema is empty (100% coverage). The description adds no parameter semantics, but the baseline for 0 parameters is 4. The error code list does not relate to 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 states 'Get the list of VPNClientConfig', which is a clear verb and resource. However, it does not distinguish from the sibling tool get_vpn_client_config_id, which presumably retrieves a single config by ID. According to the scoring criteria, this is a 4 (clear but no sibling differentiation).

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 no guidance on when to use this tool versus alternatives. There is no mention of context, prerequisites, or when not to use it. With a sibling get_vpn_client_config_id, the description should indicate that this tool is for listing all configs, not a single one. Score 2 (no guidance).

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