vyos_route_table

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

The description discloses that ValueError is raised for invalid family or protocol, and notes default values. This goes beyond the bare input schema, especially given no annotations. Minor omission of return format or pagination prevents a 5.

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 extremely concise (5 lines), front-loaded with the purpose, and every sentence adds value without redundancy or fluff.

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 no output schema or annotations, the description covers input parameters, error behavior, and defaults adequately. The only omission is a description of the output format, which for a show command is somewhat expected but not specified.

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?

With 0% schema description coverage, the description fully explains both parameters: family (with defaults and options) and protocol (optional filter with explicit list including the ability to omit). This provides critical context beyond the schema.

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 explicitly states 'Show the routing table / RIB' with specific CLI commands, clearly differentiating from sibling tools like vyos_bgp_summary or vyos_traceroute.

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 does not provide guidance on when to use this tool versus alternatives like vyos_show or vyos_bgp_summary, nor does it mention when not to use it.

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