phpipam.subnets.ensure

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

With no annotations, the description carries full burden. It states this is a write operation and lists required flags, but fails to disclose idempotency, behavior when subnet already exists, return values, or error conditions. Minimal behavioral 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 concise clauses: purpose first, then requirement. No wasted words, well-structured and front-loaded.

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 an ensure/write tool with no annotations and no output schema, a one-sentence description is insufficient. It lacks behavior on existing states, return format, and error handling, though prerequisites are included.

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% coverage with descriptions for all 5 parameters, so the schema already provides parameter meaning. The description adds no parameter-specific details, making baseline 3 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 uses a specific verb 'ensure' with resource 'subnet' and clarifies 'create if missing', making the core purpose clear. It distinguishes from read-only tools like list/get, though it doesn't explicitly differentiate from sections.ensure.

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 prerequisites (environment variables) but offers no guidance on when to use this tool versus alternatives. It does not mention checking existence with get or the relationship with similar ensure tools.

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