list_device_ipsec_phase1_interfaces

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

No annotations are provided, so the description carries the behavioral disclosure burden. It usefully notes that credential fields are stripped from the output (see _PHASE1_SECRET_FIELDS), which is valuable context. However, it does not explicitly confirm that this is a read-only operation with no side effects, nor does it mention any permission or rate-limit considerations.

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 front-loaded with the core purpose, followed by structured Args and Returns sections. Every sentence adds value, and there is no wasted text.

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 that an output schema exists and a list tool is relatively simple, the description covers the essential aspects: purpose, parameters, and a notable return behavior (credential stripping). The lack of explicit read-only or permission details is a minor gap, but overall the definition is complete enough for an agent to invoke the tool correctly.

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. It defines both parameters: 'device: Managed device name' and 'vdom: VDOM to read (default "root")', giving clear meaning for each. The explanation is concise but adequate for a simple two-parameter tool.

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 states a specific verb (List) and resource (IPsec phase1-interface definitions in a device's device DB), and it clearly distinguishes from siblings like get_device_ipsec_phase1_interface (get one) and list_device_ipsec_phase2_interfaces (phase2). An agent can identify the correct tool without opening the schema.

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 by the verb 'List' and the resource, but the description offers no explicit when-to-use guidance or alternatives. It doesn't mention when to choose this over get_device_ipsec_phase1_interface or list_device_ipsec_phase2_interfaces, leaving the agent to infer from tool names.

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