pmg_ruledb_rule_when_attach

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

No annotations exist, so the description carries full burden. It discloses mutation severity (MEDIUM), dry-run behavior, execution via confirm, configuration requirement, API path, and the conditional effect on active rules. No contradictions.

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 very concise (4-5 sentences) and front-loads the core purpose and mutation type. Every sentence adds value without redundancy.

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 existing output schema, the description covers purpose, required params, behavior, preconditions, and effect. It could mention potential errors or more on the output, but it is sufficiently complete for a mutation tool.

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 adds meaning for 'id_' and 'ogroup' beyond the schema, specifying their types and sources. It also clarifies confirm usage. Schema coverage is low (25%), but the description compensates for the key required parameters.

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 verb 'attach' and the resource 'when group to a PMG RuleDB rule'. It distinguishes from sibling attach tools like 'action_attach', 'from_attach', etc., by explicitly specifying 'when' group and providing the API path.

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 explains the dry-run default and confirm=true to execute, plus needed configuration. It does not compare against sibling attach tools, but the unique resource and parameter context imply its specific usage.

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