show_routing_table

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

Without annotations, description indicates read-only operation by stating 'Show' and listing return fields. Does not disclose behaviors like error handling or authentication needs, but covers basic behavior.

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?

Two sentences plus param description, front-loaded with purpose. No redundant 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?

Simple tool with one param and output schema present. Description explains return fields adequately. Sibling tools are similar but description is sufficient for basic usage.

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?

Single parameter 'device' has no schema description (0% coverage). Description adds meaning: 'Name of the device as defined in devices.yaml', clarifying source of device names.

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 shows the IP routing table on a network device, specifying returned fields (protocol, next-hop, metric, preference). This distinguishes it from sibling tools like show_arp_table or show_mac_table.

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?

No guidance on when to use this tool instead of alternatives (e.g., show_bgp_summary). No context on prerequisites or limitations.

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