updateMenu

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

Beyond the annotations, the description adds important behavioral details: 'Fields omitted are untouched' (partial updates) and 'Writes live data' (immediate effect). It also describes the return value including _admin_edit_url and instructs to surface it, providing actionable context not present in annotations.

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 well-structured with bold section headers (Use when, Required, See also, Returns), making it easy to scan. It is slightly longer than necessary but each section adds value, particularly the detailed return explanation.

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?

For an update tool with 5 parameters and no output schema, the description covers purpose, usage, required parameter, return value, and even provides a user-facing instruction about the admin edit link. It lacks explicit error-handling details, but this is acceptable for a CRUD operation.

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 low (20%), and the description partially compensates by mentioning menu_id as required and referencing menu_active toggling. However, it does not explicitly explain menu_name vs. menu_title, leaving some ambiguity. The _clear_fields parameter is well-described in the schema, so that does not need repetition.

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 tool's function: 'Update a menu - Update an existing menu record by ID.' It uses a specific verb and resource, and explicitly distinguishes itself from siblings by mentioning 'See also: createMenu (add new), deleteMenu (remove permanently).'

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 explicit usage scenarios: 'Use when: renaming a menu, toggling menu_active, or adjusting its CSS/HTML wrapper attributes.' It also states the required field and names alternative tools, making it clear when to use this tool vs. alternatives.

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