opnsense_dns_flush_zone

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

Discloses important side effect: 'Restarts Unbound to ensure complete cache clearing'. No annotations provided, so description carries burden. Lacks specifics on impact or duration but adds critical behavioral context.

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 sentences with no fluff. Efficiently conveys purpose, usage, and side effect. Front-loaded with primary action.

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 simple one-param tool with no output schema, the description covers purpose, usage, and behavioral impact (restart). No gaps given the tool's simplicity.

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?

Single parameter 'domain' is fully described in schema with example. Description reinforces purpose but adds no new semantic information beyond schema. Baseline 3 due to 100% schema coverage.

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 verb 'flush' and resource 'cached DNS entries for a specific domain/zone'. It distinguishes from sibling tools like 'opnsense_dns_flush_cache' by specifying zone-level operation.

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?

Provides explicit use cases: 'clear stale SERVFAIL or outdated records for a domain'. Does not explicitly exclude alternatives but context with sibling tools implies when not to use (full cache flush).

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