alphaportal_set_notification

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

The description goes beyond the annotations (readOnlyHint=false, destructiveHint=false) by disclosing the dry-run behavior, the confirm requirement, and the risk of omitted categories being reset. This is thorough coverage of the tool's actual side effects and safety nuances.

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?

Two sentences with no waste: the first sentence states the purpose and scope, the second explains the confirm gate and a critical caveat. Information is front-loaded and immediately actionable.

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 the tool's complexity (nested objects, confirm gate) and no output schema, the description covers the essential behaviors (dry-run, risk of omission). It does not state what a successful confirm returns, but that is likely implicit. The description is sufficiently complete 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?

Schema description coverage is 100% for all parameters, so the schema already documents each field. The description adds context by listing the categories, explaining the confirm parameter's role, and warning about the whole-preference-set behavior, which is extra value beyond the schema.

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 'Set' and the resource 'student's transportation notification preferences', and enumerates the exact categories it affects. This distinguishes it from sibling tools like alphaportal_list_notifications, which would be list operations.

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 explicitly explains the confirm gate and dry-run behavior, telling the agent to use confirm:true to actually apply changes and review the dry-run first. However, it does not contrast with alternatives like list_notifications, but the primary usage condition is clearly stated.

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