opn_ping

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

Since no annotations are provided, the description carries the full burden. It discloses that the ping runs on the firewall (not locally) and mentions the return format (dict with loss and RTT stats). No contradictory information. It lacks details on side effects or permissions, but for a ping tool, this is adequate.

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 very concise: four sentences, no unnecessary words. The purpose is front-loaded, and each sentence adds value (purpose, usage, execution context, return info).

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 the tool's simplicity (two parameters, no nested objects, output schema present), the description is reasonably complete. It covers purpose, usage, and return format. It could mention error handling or timeout behavior, but for a ping tool this is sufficient.

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 no descriptions (0% coverage), so the description should compensate. While 'host' is implicitly clear from the purpose, the 'count' parameter is not described. The description does not add meaning beyond the schema. Baseline 3 due to low coverage, and the description only partially addresses the parameters.

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 tool's purpose: 'Ping a host from the OPNsense firewall to test connectivity.' The verb and resource are specific, and it distinguishes from sibling tools like opn_traceroute and opn_dns_lookup.

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 explicit usage scenarios: 'Use this when you need to check if a host is reachable from the firewall, measure round-trip latency, or diagnose network connectivity issues.' It also notes that the ping runs on the firewall itself, which is important context. However, it does not mention when not to use or suggesting alternatives.

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