add-block

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

No annotations are present, so the description carries the disclosure burden. It usefully states that the tool produces a paste-ready snippet and validates props. However, it does not describe behavior on invalid props, whether schemas are fetched remotely, or any other side effects.

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, no filler; the primary action and output are front-loaded, and validation behavior is appended as a secondary clause.

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 generator tool with fully-described parameters, the description is mostly complete: it identifies input, output, and validation. It lacks explicit error/validation-failure behavior, but that's a minor gap given the simple scope.

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 100%, and each parameter already has a description (blockName examples, blockId # suffix, children references). The tool description adds no parameter-specific meaning beyond that, so baseline 3 applies.

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 names the action ('Generate'), the resource ('VTEX IO block'), and the exact output form ('JSONC snippet ... ready to paste into blocks.jsonc'). It also mentions prop validation, which separates it from scaffold/lookup siblings.

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 context is clear: use when you need a block snippet for blocks.jsonc. But there is no explicit when-not-to-use or comparison with siblings such as lookup-block-props or scaffold-vtex-app.

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