vyos_show

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

Annotations already provide readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds that it returns text output and is equivalent to the VyOS CLI show command, which is consistent with annotations and provides helpful operational context.

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 well-organized with sections for description, equivalence, args, returns, and examples. It is somewhat lengthy but every part contributes to clarity, making it easy to read and understand.

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?

For a simple read-only command tool with one parameter, the description is complete. It covers the purpose, parameter meaning, return type, and provides examples. Annotations cover safety. No output schema is shown, but the return type 'str' is stated, which 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 schema for path has detailed descriptions, but the top-level 'params' parameter lacks a description. The tool's description explains that params are path segments and provides numerous examples, adding value beyond the schema, especially since schema coverage is reported as 0% for the parameter.

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 it runs an operational-mode 'show' command, equivalent to 'show <path>' in VyOS CLI. It provides specific examples of command paths (e.g., system images, interfaces, BGP summary), distinguishing it from siblings like vyos_show_config which likely shows configuration.

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 gives explicit examples of when to use the tool for various status queries. It implicitly excludes configuration tasks but does not explicitly state when not to use it or name alternatives. The examples cover a wide range of common use cases.

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