Prepare Blocks Layout

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

No annotations are provided, so the description covers behavioral traits: the structure is valid for 60 seconds (time constraint), and warns against including the title in block data because Plone auto-manages Title blocks. This adds critical context beyond schema.

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 four concise sentences plus an example. Every sentence adds unique information, and the key details are front-loaded. No redundant or superfluous text.

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?

The tool's complexity (in-memory state, 60-second validity, dependency on subsequent calls) is well addressed. The description explains lifecycle, dependencies, and critical constraint. It does not mention return value, but no output schema is defined, so that gap is expected.

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%, so baseline is 3. The description adds value with an example, explicit warning about Title blocks, and reference to plone_get_block_schemas. This enriches parameter understanding beyond the schema's 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 explicitly states that the tool prepares a block structure in memory for 60 seconds, to be used by the next call to plone_create_content or plone_update_content. It distinguishes its purpose from sibling tools like plone_add_single_block and plone_get_block_schemas.

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 clearly indicates when to use: before calling plone_create_content or plone_update_content, and advises using plone_get_block_schemas first. It does not explicitly list when not to use, but the context implies it is for setting up a full layout, not incremental updates.

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