pmg_when_object_add

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

Declares mutation level (LOW), dry-run behavior, and the need for confirm to execute. Also includes API path and version. No annotations provided, so the description carries the burden well, though could mention side effects or idempotency.

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?

Concise and front-loaded with purpose. Sections are logically arranged: mutation label, action, dry-run/confirm, config, API path, parameter details. Dense but efficient, could benefit from bullet points.

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 what the tool does, how to use it (dry-run, confirm, config), and parameter formats. Has output schema, so return values are covered. Could mention potential errors or constraints but overall sufficient for correct invocation.

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?

Adds meaning beyond schema for the three required parameters: ogroup (numeric ID from pmg_when_groups_list), start and end (H:i format). Schema coverage is only 20%, so description compensates significantly, though confirm and proximo_target are not further explained.

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 'add a timeframe object to a PMG RuleDB 'when' object group' and specifies the resource. It distinguishes from siblings like pmg_when_object_delete and pmg_when_object_update by its unique function.

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 usage context by mentioning dry-run by default and confirm=True to execute, and notes configuration requirement (PROXIMO_PMG_*). Does not explicitly compare with alternatives but implies when to use it.

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