Detect breaking changes from commit messages and/or a git diff. Returns a list of breaking items and a version-bump recommendation.
| Name | Required | Description | Default |
|---|---|---|---|
| diff | No | Raw git diff to scan for removed exports/APIs. Optional. | |
| commits | No | Array of commit messages. Optional if diff is provided. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden for behavioral disclosure. It states that the tool returns a list and a recommendation, which suggests a read-only, non-destructive operation, but it does not explicitly mention side effects, permissions, or edge cases. It adds some output context but lacks depth on behavior.
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, well-structured sentence that front-loads the core action ('Detect breaking changes') and concisely covers inputs and outputs. Every clause earns its place, and there is no redundancy or filler.
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 tool is simple (2 optional parameters, no output schema). The description covers what it returns (list and recommendation), which compensates for the lack of an output schema. However, it does not elaborate on edge cases or what constitutes a 'breaking item', but this is not critical given the tool's straightforward scope.
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?
The input schema already describes both parameters with 100% coverage. The description adds valuable semantic context by stating inputs can be used 'and/or', clarifying the relationship between diff and commits—something the schema does not explicitly convey. This goes beyond the schema's field descriptions.
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's function: 'Detect breaking changes from commit messages and/or a git diff.' It also specifies the output ('list of breaking items and a version-bump recommendation'), distinguishing it from sibling tools like summarize_commits which likely just summarize.
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 implies when to use the tool (when breaking changes need to be detected) and mentions input sources (commit messages and/or diff), but it does not explicitly exclude alternatives or compare with siblings like generate_changelog or format_release_notes. Context is clear but no when-not guidance is given.
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.