panorama_commit

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

Annotations already flag readOnlyHint=false and destructiveHint=true, and the [MODIFIES CONFIG] prefix reinforces them without contradiction. The description adds useful behavioral context beyond the annotations: the exact scope of mutation (device groups, templates, shared objects) and the critical non-push boundary that prevents misuse.

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?

Three short sentences with no filler: the action is front-loaded, the [MODIFIES CONFIG] flag is first, the workflow pointer is second, and the exclusion closes it out. Every sentence earns its place.

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 tool with three optional parameters, full schema coverage, and safety annotations, the description covers the essential decisions: what it does, what it affects, when in the workflow to call it, and what it won't do. It doesn't mention that the commit may be tracked or verified via operation-status siblings (e.g., panorama_get_operation_status, panorama_verify_candidate_operation), but that's discoverable context for the broader workflow rather than a blocking gap.

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 100%, so the schema already documents firewall, description, and partial_admin with meaningful descriptions. The description doesn't add parameter-level detail beyond the schema, which is acceptable at the baseline 3 for high-coverage schemas.

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 action (commits pending configuration changes) on a specific resource (Panorama) and scopes it precisely to device groups, templates, and shared objects. The explicit 'does NOT push to managed firewalls' line distinguishes it from sibling panorama_push_to_devices and the generic commit tool without requiring schema inspection.

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 an explicit workflow rule: 'Use this before panorama_push_to_devices' — clearly stating when this tool fits into a sequence. It also names the alternative (panorama_push_to_devices) and states the negative case (committing on Panorama is not pushing to firewalls), so an agent knows when not to use it.

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