Prepare Blocks Layout

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

The description discloses that the structure is valid for only 60 seconds, is held in memory, and that the title block is auto-managed. This adds transparency beyond no annotations, though it doesn't explicitly state what happens if not used within 60 seconds (implied by 'valid for 60 seconds').

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 relatively concise with three sentences and an example. It front-loads the core purpose and usage, but the example and last sentence could be slightly condensed without losing clarity.

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 a single parameter and no output schema, the description fully covers what the tool does, how to use it, prerequisites, and limitations. It references sibling tools for deeper context, making it complete for an AI agent.

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?

Although the schema covers all parameters (100% coverage), the description adds significant meaning: it explains the blocks array purpose, references plone_get_block_schemas for required fields, and includes warnings and an example. This goes well beyond the schema.

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 prepares a block structure in memory for use by plone_create_content or plone_update_content. It distinguishes from siblings like plone_add_single_block by specifying this is for a complete layout, not a single block.

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?

It advises to call plone_get_block_schemas first for block data requirements, and warns against adding the title in block data. It also indicates that the structure must be used in the next immediate call, providing clear when-to-use context.

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