panorama_ipsec_bgp_guide

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

The description explicitly says '[READ-ONLY]', 'Static playbook', 'Performs no API calls and mutates nothing.' This goes beyond the readOnlyHint annotation by clarifying there are no side effects and no actual API interaction, which is important for an agent deciding whether calling it is safe.

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 most important facts: READ-ONLY, static playbook, and call-first guidance. The long 'Covers...' sentence is dense and could benefit from bullet-style structuring, but every listed item adds useful information for an agent evaluating the tool.

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 this is a static guide with no parameters and no output schema, the description is remarkably complete. It covers the workflow sequence, key constraints, human-vs-auto responsibilities, naming conventions, and explicitly states when to call it, leaving no critical context missing.

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 tool has zero parameters and an empty input schema, so there are no parameter semantics to explain. The description compensates by clarifying that the tool takes no input and performs no operations, which is sufficient.

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 this is a 'static playbook for provisioning IPsec + BGP-over-IPsec on any Panorama the server is connected to.' It uses a specific verb/resource pair and differentiates itself from sibling operational tools by explicitly noting it performs no API calls and mutates nothing.

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 when-to-use guidance: 'Call this first in a session to learn the workflow without trial-and-error.' It also enumerates the required tool sequence, effectively mapping when each sibling tool should be used relative to this guide, and clarifies that the playbook itself performs no API calls.

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