run_ping_diagnostic

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds valuable context that the ping originates from the pfSense firewall, which is a meaningful behavioral detail not captured by annotations or schema. For a simple read-only diagnostic, this is sufficient.

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, focused sentence with no redundant wording. It conveys the essential purpose in under ten words, making it easy to parse and remember.

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?

The tool is simple with clear annotations, a complete input schema, and an output schema present. The description plus structured data fully cover what the tool does and where it operates, leaving no critical gaps for a diagnostic action.

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 coverage is 100% with both 'host' and 'count' described. The description itself adds no parameter information, but the schema fully documents the parameters, so the baseline of 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?

Description clearly states the tool runs a ping diagnostic from the pfSense firewall, using a specific verb ('run') and resource ('ping diagnostic'). It distinguishes itself from broader diagnostic siblings like diagnose_connectivity by focusing on a specific 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?

The description implies use for testing network reachability but provides no explicit when-to-use or alternative comparisons. It does not mention that this is a targeted ping as opposed to a broader connectivity diagnostic, leaving the agent to infer its role among siblings.

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