add_audit_group

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

No annotations provided, so description carries full burden. It discloses idempotency, immediate effect on live policy, and the eventual consistency risk with clear mitigation advice.

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 with purpose, idempotency, cautions, and args. Efficiently uses sentences without waste, though the args section could be more concise.

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 preconditions (auditing enabled), behavioral nuances (eventual consistency), and output schema exists. Does not describe return value, but that is covered by output schema.

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. Description lists parameters and gives an example for 'group' (e.g., BATCH_COMPLETED_GROUP), but workspace and warehouse lack any format or context beyond names.

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 clearly states it adds a single audit action group without overwriting others, distinguishing it from bulk operations. The idempotency note reinforces its specific behavior.

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 states auditing must already be enabled and warns about spacing writes due to eventual consistency. However, it does not explicitly contrast with siblings like set_audit_action_groups.

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