generate_pr_title

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

No annotations provided, so the description carries full burden. It discloses that the tool returns a prompt for analysis, not a final answer, and warns with 'CRITICAL'. It explains the AI must read the context and generate a title, which is transparent about the unusual input-output relationship.

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 lengthy but necessary given the unusual tool behavior. It is front-loaded with a warning and provides clear steps. Could be slightly more concise, but still well-structured.

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 the complexity (tool returns a prompt for AI to process), the description is complete. It explains output, AI's role, and how to use the result. No output schema, but return behavior is described clearly.

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?

Only one parameter (maxLength) with 100% schema coverage. The description does not add details about how maxLength affects the prompt or title, but the schema already describes it. 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 clearly states that the tool returns an analysis prompt for the AI to generate a PR title, not a final title. It specifies the verb 'generate' and the resource 'PR title' with an explicit twist, distinguishing it from siblings like create_pr.

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 explicitly says 'Use when creating PR or when user asks for a PR title' and instructs the AI to not return the prompt but generate a title. It also references sibling tools: 'should then be passed to create_pr or create_pr_complete tools.'

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