Generate a pull request description with summary, change stats, and a test checklist.
| Name | Required | Description | Default |
|---|---|---|---|
| diff | No | Raw git diff output. Optional but improves stats. | |
| title | No | PR title. Optional. | |
| commits | Yes | Array of commit messages included in the PR. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of disclosing behavior. It mentions the output components but does not explain how the tool processes inputs, whether it makes external calls, or what limitations exist. This is a significant gap for a tool that generates a PR description from commits and diff.
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 a single sentence that front-loads the action and provides a concise list of included elements. Every word contributes value, and there is no wasted 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 description covers the core output components but lacks guidance on when to use this tool relative to siblings, lacks behavioral details (e.g., whether it returns markdown, how it handles missing diff), and there is no output schema to fill gaps. It is adequate but not fully complete for an agent selecting the tool.
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%, with each parameter documented in the schema. The description adds no additional meaning beyond the schema, so the baseline score of 3 is appropriate. The 'diff' optionality is not elaborated in the description, but the schema already explains it.
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 a specific verb+resource: 'Generate a pull request description' and lists the components (summary, change stats, test checklist). This distinguishes it from sibling tools like generate_changelog or summarize_commits, which target different outputs.
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 no guidance on when to use this tool versus alternatives, nor does it mention any exclusions or prerequisites. It simply states what it does, leaving the agent to infer usage from the name and output description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
The three commit-to-text tools (summarize_commits, generate_changelog, format_release_notes) overlap in purpose, though each targets a different output format. detect_breaking_changes and generate_pr_description are clearly distinct.
All tools follow a consistent verb_noun pattern (detect, format, generate, summarize) with clear, readable names. No mixed conventions.
Five tools is well-scoped for a changelog-writing server, covering the full generation pipeline without redundancy or bloat.
The core changelog lifecycle is covered: summarize commits, detect breaking changes, generate changelog, and format release notes. The PR description tool is a bonus. Minor gap: no tool for editing or updating an existing changelog.