audit_ibm

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

Discloses requirement for Node engine runner and network egress, and that failure returns a structured engine-error. No annotations exist, so description carries full burden.

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?

Two sentences plus a note, no filler. Purpose is front-loaded, each sentence adds distinct value.

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 4 parameters, no annotations, and an output schema, the description covers mutual exclusivity, prerequisites, and error conditions. The output schema handles return value documentation.

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 description clarifies that url, html, and session_id are mutually exclusive options, adding meaning beyond the schema. However, the 'level' parameter is not explained, and schema coverage is 0%.

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?

Clearly states 'Audit with the IBM Equal Access engine only' – a specific verb and resource that distinguishes it from sibling tools like audit_axe or audit_lighthouse.

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 says 'Provide one of: url, html, or session_id' and mentions requirements and error behavior. Could be improved by explicitly stating when not to use this tool, but the context is clear.

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