vmware-nsx-security

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

No annotations are provided, so the description carries the full burden. It adds value by documenting the return fields (id, display_name, action, etc.), but fails to declare behavioral traits like 'read-only', 'safe', or pagination behavior that would help the agent understand operational constraints.

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 well-structured with clear sections for purpose, return values, and arguments. It is appropriately concise with no wasted words; every sentence provides necessary information about the operation or its parameters.

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 it has an output schema (not shown but indicated) and only two simple parameters, the description is reasonably complete. It documents the parameters and lists return fields, though it could benefit from mentioning pagination or result limits for a 'list all' operation.

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?

With 0% schema description coverage, the description compensates adequately by documenting both parameters: policy_id as 'Parent policy identifier' and target as 'Optional NSX Manager target name from config'. This provides essential context missing from the schema.

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 'List[s] all rules in a DFW security policy' with a specific verb and resource. It implicitly distinguishes from siblings like list_dfw_policies (rules vs policies) and create_dfw_rule, but does not explicitly name alternative tools or differentiate when to use each.

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 lacks explicit guidance on when to use this tool versus alternatives like get_dfw_policy or create_dfw_rule. While the Args section implies you need a policy_id to list its rules, there are no explicit when-to-use or when-not-to-use instructions.

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