dialplan_add_rule

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

No annotations exist, so the description must carry the behavioral burden. It only lists parameters and does not disclose side effects (e.g., whether adding a rule triggers a reload, affects active calls, or requires specific permissions). The 'reload' parameter is mentioned but not explained.

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 efficiently structured with a one-line intro and a bulleted parameter list. It avoids unnecessary words and is easy to scan, though it could be slightly more concise by grouping related parameters.

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?

With 11 parameters (4 required), no annotations, and an output schema present, the description is incomplete. It fails to explain several parameters, does not describe return values, error cases, or usage context. The absence of behavioral context further reduces completeness.

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 to several parameters (e.g., match_op values, match_exp as pattern, etc.), which is helpful given the schema has no descriptions. However, it omits explanations for match_flags, timerec, disabled, attrs, and reload, leaving 4 of 11 parameters undocumented.

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' and the resource 'dialplan translation rule', making it distinct from sibling tools like delete, update, list, etc. The verb+resource combination is specific and unambiguous.

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 provides no guidance on when to use this tool versus alternatives (e.g., dialplan_update_rule, dialplan_delete_rule). It lacks context on prerequisites, typical use cases, or situations to avoid.

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