get_dfw_rule_stats

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

Annotations already provide readOnlyHint and other hints. Description adds meaning to return fields (e.g., population_count explained as number of hosts where rule is realised). Adds [READ] tag. Does not cover rate limits or permissions, but adds significant context beyond annotations.

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 concise: purpose and return values in one paragraph, parameters in another. No filler, front-loaded with key info.

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?

Covers purpose, return fields, parameter meanings. Lacks error behavior or what happens if rule doesn't exist, but for a simple read operation with no output schema, remaining gaps are minor.

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 has 0% description coverage, but the description's Args block explains each parameter: policy_id as 'Parent policy identifier', rule_id as 'Rule identifier', target as 'Optional NSX Manager target name'. This compensates fully for missing schema descriptions.

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 it gets hit-count statistics for a DFW rule, lists the returned fields (packet_count, byte_count, etc.), and uses [READ] to indicate read-only operation. It distinguishes from sibling tools like get_dfw_policy and list_dfw_rules.

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?

No explicit guidance on when to use this tool over alternatives (e.g., get_dfw_policy, list_dfw_rules). Usage is implied: when you need statistics for a specific rule. No when-not-to-use or alternative references.

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