opnsense_kea_apply

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

Description indicates a write operation that reconfigures the service. Without annotations, it carries the full burden and adequately conveys the action's effect, though it could mention stability or restart implications.

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?

Single sentence front-loads purpose and usage. No extraneous information.

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 no-parameter action, the description fully covers what the tool does and when to use it. No output schema needed for such a simple operation.

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?

Input schema has no parameters, so description cannot add param details. Nevertheless, it is consistent and complete.

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?

Description clearly states it applies pending Kea DHCP changes and reconfigure service, and specifies it runs after subnet or reservation changes. Distinguishes from sibling tools that create or modify configurations.

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?

Explicitly says 'Run after subnet or reservation changes,' providing clear context for when to use. No mention of when not to use or alternatives, but the simple apply action does not require extensive exclusions.

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