pmg_ruledb_rule_what_attach

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

No annotations provided, so description carries full burden. Discloses that it's a mutation with medium impact, dry-run by default, and conditional effect ('Only affects mail flow if the rule is active'). 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?

Four concise sentences, each providing essential info. Front-loaded with action and risk level. No redundant words. Efficiently structured.

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 purpose, parameters, behavior, and side effects. Output schema exists, so return values are documented elsewhere. Complete for a mutation tool with this context.

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 coverage is low (25%), but description adds critical meaning: id_ is rule ID, ogroup is numeric what-group ID from pmg_what_groups_list, and confirms the role of confirm as execution flag. 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?

Clearly states the action ('attach a 'what' group'), the resource ('PMG RuleDB rule'), and provides a specific verb-resource combination that distinguishes it from sibling tools like detach or list.

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?

Describes the default dry-run behavior and how to execute ('confirm=True'). Mentions required config. Provides the API path and clarifies that it only affects mail flow if the rule is active. Lacks explicit when-not-to-use guidance, but the usage context is clear.

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