vpn_ssl_settings_update

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

With no annotations, the description must fully disclose behavioral traits. It only states 'Update' but does not mention side effects (e.g., whether existing connections are dropped), required permissions (e.g., admin privileges), or update semantics (e.g., incremental vs full replacement). This is insufficient for a mutation tool.

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 concise at five words, but it effectively communicates the core action and target. While it could include more detail, it does not waste words. It earns its place by immediately clarifying the tool's purpose.

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 mention important context such as the tool's scope (global settings), default behaviors, required permissions, or interaction with other VPN settings. For a tool with six parameters and no annotations, this level of completeness is insufficient for reliable agent usage.

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 input schema has 100% description coverage, with each parameter clearly documented (e.g., 'port' as listening port, 'idle_timeout' as timeout in seconds). The tool description adds no extra meaning beyond the schema, so a baseline score of 3 is appropriate.

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 clearly states the action ('Update') and the resource ('SSL VPN global settings'). This distinguishes it from sibling tools like vpn_ssl_settings_get (read) and vpn_ssl_portal_* (portal-specific settings), making the tool's purpose unambiguous.

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 is provided on when to use this tool versus alternatives. For instance, there is no mention of prerequisites, context, or situations where another tool (e.g., vpn_ssl_portal_create) would be more appropriate. The description lacks any conditional usage instructions.

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