get_idps_status

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

Beyond annotations, it reveals the return bundle is 'one bundle, not an envelope,' describes the structure of 'signature_status' and 'settings,' and notes that 'signature_status' may be empty where IDS was never enabled. This adds valuable behavioral context not covered by readOnlyHint/idempotentHint.

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 front-loaded with '[READ]' and a clear summary, then uses compact bullet-like sentences to explain return structure, edge cases, and usage. Every sentence adds value with no fluff.

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 there is no output schema, the description compensates by explaining the return bundle's two sections, the varying field names by NSX release, and the empty-state edge case. It also provides enough context for an agent to know when to call this versus siblings.

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 only parameter 'target' is described as 'Optional NSX Manager target from config,' which adds a small amount of context beyond the bare schema, but lacks details on accepted values or behavior when omitted. Since schema description coverage is 0%, the description carries responsibility, and it does so minimally.

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 'Get IDPS signature status and global IDS settings' with a specific verb and resource, and distinguishes from sibling list_idps_profiles by advising 'Use it first to confirm IDS is on and current, then list_idps_profiles for the profiles.'

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?

Explicitly provides when to use this tool: 'Use it first to confirm IDS is on and current' and when not: 'No per-signature or per-event detail.' It also suggests the alternative sibling tool, making usage guidelines very clear.

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