pve_sdn_vnet_firewall_options_get

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

With no annotations provided, the description carries the full burden. It clearly states the tool is READ-ONLY, has no pending/apply lifecycle, and that changes via the setter take immediate effect on live traffic. It also mentions the default for 'enable'. This provides good transparency, though it could mention permission requirements or error conditions.

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 only four sentences, front-loaded with the purpose. Every sentence adds essential information: purpose, lifecycle distinction, default value, and pointer to the setter. No wasted words.

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 getter with one required parameter, the description covers the key aspects: read-only, immediate effect, defaults, and related setter. The existence of an output schema covers return value details. It could mention prerequisites (e.g., vnet must exist) but this is not critical.

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 baseline is 3. The description does not add extra meaning for the input parameters (vnet and proximo_target) beyond what the schema already provides. It mentions the returned fields but that does not enhance input parameter semantics.

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 starts with 'READ-ONLY: get vnet firewall options' and lists the specific fields (enable, log_level_forward, policy_forward). It clearly states what the tool does and distinguishes it from siblings by noting the live/immediate lifecycle vs. other SDN objects that require a pending/apply step.

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 explicitly tells the agent to use pve_sdn_vnet_firewall_options_set for changes, providing an alternative. It also contrasts the immediate effect with other SDN objects, helping the agent understand when to use this getter. However, it does not explicitly state when not to use this tool beyond read-only context.

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