zia_get_malware_settings

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

Annotations already provide readOnlyHint=true, and the description reinforces read-only nature while detailing the structure (16 booleans, *_capture toggles). However, it does not describe the exact response format or any potential limitations beyond the PUT-replace warning for the update tool.

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?

Description is well-structured and informative without being overly verbose. All sentences contribute value: purpose, content, usage guidance, and filtering option. Could be slightly trimmed but effective.

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 no output schema, the description adequately describes the return value (16 booleans with specific threat categories) and explains the relationship to the update tool. For a read-only tool, this is fully adequate.

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?

Input schema has 100% coverage for both parameters. Description adds context by explaining the query parameter for JMESPath filtering and the service parameter's default value. No additional meaning needed beyond what schema provides.

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 the tool retrieves the full ZIA Malware Protection threat-class settings block as a read-only operation. It lists the specific threat types covered (virus, trojan, etc.) and mentions 16 booleans plus PCAP toggles, distinguishing it from sibling get_* tools.

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?

Explicitly instructs to call this tool before zia_update_malware_settings to merge partial updates, explaining that the update is PUT-replace and omitted fields reset to False. Also mentions JMESPath filtering for client-side projection.

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