Generate Playwright test from report

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

Description adds context beyond annotations: says it's a write operation that consumes LLM budget and is not idempotent (each call opens new PR). Annotations already indicate non-idempotent, but description fleshes out implications.

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: first explains core action, second provides usage guidance and output info. No wasted words. Front-loaded with purpose.

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?

Covers input, output shape, side effects, prerequisites, and context for use. No output schema exists, but description provides return value shape.

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?

Input schema covers both parameters with descriptions (100% coverage). Description does not add additional parameter details beyond schema. Baseline 3 is appropriate.

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?

Description clearly states it generates a Playwright regression test from a classified report and opens a draft PR. Verb and resource are specific. Explicitly distinguishes from sibling generate_tdd_from_story.

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?

Provides explicit when to use (lock in regression as E2E test) and when not to use (use generate_tdd_from_story instead). Also mentions prerequisites (inventory_v2 plan, GitHub and LLM keys).

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