vyos_ping

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

No annotations are provided, so the description carries full behavioral burden, and it does substantial work: it discloses the return shape (ping output in the data field), the error semantics (router reports failure and the tool errors with the ping output), and a hard version dependency with a graceful degradation message. It does not cover timeout/packet-size behavior or any permission requirements.

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?

Front-loaded with the one-line purpose, then return/failure/version details, then an Args block that maps cleanly to the schema. Every sentence is load-bearing, though the return-behavior paragraph is slightly dense for what it conveys.

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?

With no annotations and no output schema, the description covers everything an agent needs: what it does, what it returns, how failure manifests, the required router version, and the meaning of each argument. Nothing material is left for the agent to infer.

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 description coverage is 0%, so the description must compensate, and it largely does: it documents all three parameters, adds a valid range (count 1-10) and default (5) not present in the schema, and gives a concrete host example. The vrf entry is thin ("Optional VRF to ping from") and leaves the accepted VRF naming format unspecified.

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?

"Ping a host from the router" names a specific verb and resource and clarifies the vantage point (executed on the router, not the caller). It is clearly separable from the closest sibling, vyos_traceroute, but the description never names that alternative or states the distinction explicitly.

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?

Usage is implied rather than guided: the version gate (VyOS rolling 2026.08.18+) and the failure-on-no-reply behavior imply when the tool is applicable. There is no explicit statement of when to prefer this over vyos_traceroute or other reachability tools.

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