opnsense_nat_source_update

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

The description mentions round-trip and destructive behavior, but with no annotations, it fails to explain specific effects, permissions, or irreversible actions beyond the vague term 'DESTRUCTIVE'.

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 short and to the point, but the all-caps 'DESTRUCTIVE' could be better integrated; overall minimal 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 20 parameters and no output schema or annotations, the description is woefully incomplete, missing field semantics, error behavior, and return format.

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?

With only 5% schema description coverage (only uuid described) and no parameter explanations in the description, the agent cannot understand what each field controls or how to set them.

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 (existing Source NAT rule), distinguishing it from sibling tools like add, delete, or toggle.

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?

It implies usage for modifying existing rules but lacks explicit guidance on when not to use it or alternatives like toggle or delete.

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