clear_mealplan_week

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

With no annotations, the description carries the full load and does disclose the most important behavior for a destructive tool: a dry-run default with an explicit confirm gate. It omits irreversibility, scope of deletion (all entries vs. only mealplan), and permission requirements.

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?

A single tight sentence with zero filler, front-loading the dry-run behavior and then the action trigger. Nothing redundant.

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?

An output schema exists, so the preview/result shape needn't be explained. But for a destructive operation with no annotations, key facts are missing: whether deletion is irreversible, date format/inclusivity of the range, and whether 'week' in the name constrains the range.

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 0%, so the description must compensate. It explains confirm meaningfully (default = preview, True = execute), which is the non-obvious parameter, but says nothing about start_date/end_date format or inclusivity despite both being required strings.

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?

States a specific verb (remove/clear) and resource (mealplan entries in a date range), plus the preview behavior. It implicitly distinguishes itself from the single-entry sibling delete_mealplan_entry, though it never names it, and the name's 'week' scope is broader in the description as an arbitrary date range.

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?

Gives a clear operating condition: call as-is to preview, pass confirm=True to actually clear. That is a real when-to-use rule for the two modes. It stops short of naming delete_mealplan_entry as the alternative for removing a single entry.

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