vyos_configure

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

Discloses critical behavior: auto-rollback after 5 minutes unless confirmed. With no annotations, the description provides essential safety context. It does not cover error handling or idempotency but addresses the key behavioral trait.

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?

Very concise: 5 lines total, with key information front-loaded. No redundant information. Every sentence adds value.

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?

Covers the single parameter and main behavior. Does not detail return values or error conditions, but for a configuration tool with this complexity, the description is adequate. Slight gap in not mentioning idempotency or prerequisites.

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 coverage is 0% (only array of objects with additionalProperties), but the description fully documents the parameter format: each command has 'op' ('set'/'delete') and 'path' (list of strings). Includes an example, adding significant meaning 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?

Clearly states 'Apply VyOS configuration with commit-confirm (auto-rollback after 5 min)'. Verb 'apply' and resource 'VyOS configuration' are explicit. The auto-rollback feature distinguishes it from siblings like vyos_confirm and vyos_load.

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?

Describes as 'the safe default' and directly references vyos_confirm for confirmation, providing clear context on when to use this tool. However, it lacks explicit exclusion scenarios.

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