vmware-nsx-security

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

With no annotations provided, the description carries the full burden and successfully discloses return values (id, display_name, category, sequence_number, stateful flag, and rule count). It implies a read-only operation through the verb 'List' but does not explicitly state safety guarantees or pagination 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?

The description is efficiently structured with clear sections for purpose, return values, and arguments. No filler text is present. The Args format is slightly docstring-style but remains readable and front-loads critical information.

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 the presence of an output schema (which handles return value documentation) and only one optional parameter, the description provides adequate context by specifying the 'default domain' scope and NSX Manager target details. It appropriately covers the complexity without redundancy.

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?

The schema has 0% description coverage, but the description fully compensates by documenting the target parameter: 'Optional NSX Manager target name from config. Uses default if omitted.' This provides complete semantic meaning where the schema failed.

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 explicitly states 'List all DFW security policies in the default domain' — providing a specific verb (List), resource (DFW security policies), and scope (default domain). This clearly distinguishes it from siblings like get_dfw_policy (single retrieval) and list_dfw_rules (rules vs policies).

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 phrase 'List all' implies usage (when you need the complete set), but the description lacks explicit when/when-not guidance or named alternatives. It does not clarify when to prefer this over get_dfw_policy for single-policy lookups.

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