createMenuItem

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

Annotations show readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true. The description confirms writes ('Writes live data') but does not disclose authorization needs, side effects, or return value. With annotations providing some safety profile, the description provides moderate additional context but lacks completeness.

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 about 10 lines, front-loaded with purpose, then covers usage, required fields, enums, parameter interactions, and see-also. Every sentence is necessary and contributes to understanding, with no wasted words.

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 complexity (9 params, 5 required, no output schema), the description covers usage conditions, parameter interactions, enums, and provides a sibling reference. However, it omits return value and error conditions, which would enhance 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?

Schema description coverage is only 44% (4/9 params have descriptions). The description adds valuable semantics for key parameters: explains `menu_id` as parent menu container, `master_id` as 0 for top-level, `menu_order` as position, and `menu_target` enums. It compensates significantly for the schema gaps.

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 starts with 'Create a menu item - Create a new menuitem record. Writes live data.' It clearly identifies the verb (create) and resource (menu item), and distinguishes from siblings like 'createMenu' and 'updateMenuItem'.

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 when-to-use: 'adding a nav link to an existing menu. Parent `menu_id` must exist. For nested items pass `master_id=<parent menu_item_id>`; for top-level pass `0`.' It also references 'updateMenuItem' for modifications, offering clear context and alternatives.

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