scaffold_admin_notice

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

With no annotations, the description effectively discloses behavioral traits: it generates a notice with user dismissal, persistence via user meta, conditional display, and proper escaping/styling. However, it does not mention potential side effects like file creation or overwriting.

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 sentence of 15 words, front-loaded with the action 'Generate a WordPress admin notice'. Every part of the sentence adds value, listing key features succinctly.

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 a tool with 8 parameters, no output schema, and no annotations, the description covers the purpose and key features but lacks details on return values, side effects (e.g., file creation), prerequisites, or usage examples. It is adequate but not comprehensive.

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 input schema has 100% coverage with descriptions for all 8 parameters, so the burder on the description is low. The description provides an overview but does not add meaning beyond the schema's individual parameter descriptions.

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 generates a WordPress admin notice, using a specific verb and resource. It lists key features (dismissible, persistent, conditional, escaping, styling), distinguishing it from sibling tools that scaffold other WordPress elements.

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 implies usage for generating admin notices but does not explicitly state when to use this tool versus alternatives like scaffold_meta_box or scaffold_settings_page. No when-not or alternative guidance is provided.

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