Delimit Docs Generate

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

The description discloses the side effect of writing a markdown reference file via backends.ui_bridge.docs_generate, beyond the annotations. It also clarifies a behavioral limitation: generation does not validate docs. This goes well beyond the structured annotation fields.

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 well-structured with labeled sections and front-loaded purpose. There is slight redundancy between the 'When NOT to use' and 'Sibling contrast' sections, both covering the validation distinction, but overall it is compact and scannable.

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 tool with one optional parameter, an output schema, and clear annotations, the description covers purpose, usage, alternative, and side effects. Nothing essential is missing for an agent to select and invoke this tool correctly.

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 description coverage is 100%, with the single 'target' parameter fully documented in the schema including its default '.'. The description adds project-level context but does not need to compensate for schema gaps. 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?

The description states a specific action ('Generate a markdown API reference') and resource ('from source docstrings/JSDoc'), and clearly distinguishes itself from delimit_docs_validate, which inspects existing docs. An agent immediately knows what this tool produces and how it differs from its sibling.

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 provides explicit 'When to use' and 'When NOT to use' guidance, names the alternative tool delimit_docs_validate, and explains the key distinction: generation does not validate. This leaves no ambiguity about when to choose this tool.

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