preview_stitch_plan

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

No annotations are provided, so the description must disclose behavioral traits. It mentions adding a layer and mode options but does not state side effects (e.g., whether the SVG is modified in place or a copy is created), permission requirements, or effects on original data. The output_svg_path parameter hints at output behavior, but this is not explained.

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?

Extremely concise with only one sentence plus a mode hint. No wasted words, but could benefit from a brief structure or list to improve scannability. The core action is front-loaded.

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 6 parameters, no output schema, and no annotations, the description is severely incomplete. It does not explain the return value (likely the modified SVG or a path), the effect of 'layer_visibility', or the purpose of 'render_jumps' and 'needle_points'. Agents are left with many unknowns.

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 0%, so the description must compensate. It only adds meaning for 'mode' by listing two values ('simple' or 'realistic-vector'). Other parameters like 'svg_path', 'render_jumps', 'needle_points', 'output_svg_path', and 'layer_visibility' are not described, leaving agents to infer from names and defaults.

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 adds a rendered stitch-plan layer to an SVG, specifying what will be sewn. It distinguishes from siblings like 'render_png_preview' (renders PNG) and export tools by focusing on a specific visualization. The verb 'add' and resource 'rendered stitch-plan layer' are precise.

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?

No guidance on when to use this tool vs alternatives (e.g., 'render_png_preview' for bitmap previews, 'design_stats' for analysis). Does not mention prerequisites or conditions for effective use, such as requiring an existing stitch plan.

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