pmg_what_object_delete

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

Discloses mutation, dry-run default, confirm flag, config requirement, and exact API path. Could mention idempotency or error handling, but adequate for a delete operation with no annotations.

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?

Description is concise and front-loaded with purpose. Single paragraph is acceptable but could be broken into bullet points for clarity. No wasted words.

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 essential aspects: operation, configuration, IDs source, dry-run. Output schema handles return values. Slightly lacking on edge cases (invalid IDs, concurrent modifications), but sufficient for typical use.

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?

Despite low schema description coverage (25%), description adds meaningful context for required parameters (ogroup and id_) by referencing source lists, and explains confirm default. Compensates well for schema gaps.

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 it deletes an object from a PMG RuleDB 'what' object group, specifies mutation and dry-run default, and distinguishes from related tools like add/update.

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?

Provides clear context on when to use (delete with known IDs), mentions prerequisite calls (pmg_what_groups_list, pmg_what_group_objects), but lacks explicit alternative tools or when-not-to-use scenarios.

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