pmg_ruledb_rule_to_attach

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

Discloses mutation severity, dry-run default, execution trigger (confirm=True), config requirement, and conditional effect on mail flow. No annotations provided, so description fully covers behavioral traits.

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?

Compact paragraph covering action, usage, path, and parameters. Every sentence adds value, though a bullet list could improve scanability.

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 action, parameters, behavior, and config. Does not mention return value, but output schema exists. Adequate for agent to use correctly.

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 only describes proximo_target (25% coverage). Description adds meaning for id_ (rule ID), ogroup (numeric who-group ID from list), and confirm (execution control). 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 the action ('attach a 'to' group to a PMG RuleDB rule') and resource, distinguishing it from siblings like pmg_ruledb_rule_to_detach and pmg_ruledb_rule_to_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?

Provides explicit context: dry-run by default, confirm=True to execute, config requirement, and effect condition. However, does not explicitly differentiate when to use this vs other attach tools (e.g., from, what, action).

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