openwisp_create_vpn

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

With no annotations, the description carries the full behavioral burden yet discloses almost nothing: no auth/permission requirements, no duplicate-name handling, no idempotency or return behavior. The HTTP POST endpoint is the only oblique signal that this is a write operation.

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?

Two tight clauses with the action front-loaded and no filler. The category/HTTP boilerplate is marginal but harmless and non-redundant.

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?

For a trivial one-parameter create tool with a fully documented schema and no output schema, the description is barely sufficient. It omits any auth note or post-create behavior, which matters for an unannotated mutation tool.

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?

Schema description coverage is 100%, so the sole parameter ('name': 'VPN name') is already fully documented in the schema. The description adds no format, constraint, or default information beyond the schema, so the baseline 3 applies.

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?

States a specific verb and resource ('Create a VPN resource') and the category tag plus HTTP POST endpoint reinforce the intent. The verb clearly separates it from list/get/update/patch/delete VPN siblings, though no sibling is named explicitly.

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?

There is no when-to-use guidance, prerequisite, or mention of alternatives. An agent can only infer from 'Create' that this is the entry point for a new VPN, with no exclusions offered.

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