vmware-nsx-security

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

With no annotations provided, description carries full burden. It discloses the ValueError exception condition (important for a deletion tool) but omits reversibility, auth requirements, or success behavior.

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?

Front-loaded with main action, followed by critical error condition, then Args section. No wasted words, though the docstring-style Args formatting is slightly less compact than inline text.

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 essential deletion behavior and error conditions for a 2-parameter tool. Given no output schema exists, could improve by stating what occurs on successful deletion (e.g., returns void/confirmation).

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 (titles only). Description compensates well by documenting both parameters: 'ID of the group to delete' and 'Optional NSX Manager target name from config'.

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?

Description opens with specific verb 'Delete' and specific resource 'NSX security group', clearly distinguishing from siblings like delete_dfw_policy, delete_dfw_rule, or create_group.

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?

Provides critical usage constraint: raises ValueError if group is referenced by DFW policy rules. However, lacks explicit when-to-use guidance vs alternatives like create_group or update workflows.

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