vmware-nsx-security

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

With no annotations provided, the description carries full burden. It discloses return values (id, display_name, description, expression count) which is helpful, but fails to explicitly state this is read-only/safe or mention pagination behavior for large result sets.

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?

Well-structured docstring format with clear separation of purpose, return values, and arguments. Front-loaded with the main action, zero redundant text, appropriate length for a single-parameter tool.

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 simple single-parameter input and existence of output schema, the description is reasonably complete. It covers the parameter semantics and return structure. Could be improved by noting read-only nature or pagination limits given zero annotations.

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?

Excellent compensation for 0% schema coverage. The Args section clarifies that 'target' is an NSX Manager target name from config and that it's optional, adding crucial context entirely 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 lists NSX security groups with specific scope (default domain). It implicitly distinguishes from sibling get_group via plural 'List all' vs singular, though it doesn't explicitly contrast 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 mentions 'default domain' implying scope constraints, but provides no explicit guidance on when to use this versus get_group or whether target parameter is required for multi-manager environments. Usage is implied by 'List all' but not guided.

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