Skip to main content
Glama

GitHub release notes generator

github_release_notes
Read-onlyIdempotent

Write the release notes for a release or tag of a public GitHub repository: compares two of its releases or plain Git tags (default: the latest release vs the one before) and turns the commits and merged pull requests between them into a Keep a Changelog 2.0.0 section with breaking changes flagged and their migration steps, plus plain-language release notes that thank the contributors. With mode "backfill" it writes the notes for each tag in a run of consecutive version tags (up to 10; by default the newest tags that were never published as GitHub releases) and returns a ready-to-run gh release create <tag> --notes-file … script that publishes them. Also returns the merged pull requests, the releases and tags to pick from (each labelled release or tag) and how each commit was sorted. Deterministic, no AI, no sign-in.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "repository": "<repository>"
    },
    "name": "github_release_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoThe release or plain tag to write notes for. Default: the latest release. A branch name gives what's merged since `from`. In backfill mode: the newest tag of the run; default: the newest tag without a GitHub release.
fromNoThe earlier release or tag (not included). Default: the release before `to` (the tag before it for a plain tag). In backfill mode: the tag the run starts after; default: the nearest release before `to`.
modeNo"single" (default): one release. "backfill": every tag after `from` up to `to`, each compared with the tag before it, plus a script that creates the missing GitHub releases.
outputNoWhat the text answer contains: "both" (default: release notes and Keep a Changelog; in backfill mode also the script), "keep-a-changelog" (CHANGELOG.md sections), "release-notes" (for GitHub releases or an announcement) or "script" (backfill only: the gh script).
repositoryYesPublic github.com repository: "owner/repo" or its URL. A release URL (…/releases/tag/v1.2.0) or compare URL sets the range too.
include_prereleasesNoBackfill only: include pre-release tags such as v2.0.0-rc.1 in the run. Default false, so each stable release covers everything since the stable one before it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / from / description
      Previous value: -"The earlier release's tag (not included). Default: the release before `to`."New value: +"The earlier release or tag (not included). Default: the release before `to` (the tag before it for a plain tag). In backfill mode: the tag the run starts after; default: the nearest release before `to`."
    • addedInput schema / properties / include_prereleases
      Added value: +{
      +  "description": "Backfill only: include pre-release tags such as v2.0.0-rc.1 in the run. Default false, so each stable release covers everything since the stable one before it.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / mode
      Added value: +{
      +  "description": "\"single\" (default): one release. \"backfill\": every tag after `from` up to `to`, each compared with the tag before it, plus a script that creates the missing GitHub releases.",
      +  "enum": [
      +    "single",
      +    "backfill"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / output / description
      Previous value: -"What the text answer contains: \"both\" (default), \"keep-a-changelog\" (a CHANGELOG.md section) or \"release-notes\" (for a GitHub release or announcement)."New value: +"What the text answer contains: \"both\" (default: release notes and Keep a Changelog; in backfill mode also the script), \"keep-a-changelog\" (CHANGELOG.md sections), \"release-notes\" (for GitHub releases or an announcement) or \"script\" (backfill only: the gh script)."
    • changedInput schema / properties / output / enum
      Previous value: -[
      -  "both",
      -  "keep-a-changelog",
      -  "release-notes"
      -]New value: +[
      +  "both",
      +  "keep-a-changelog",
      +  "release-notes",
      +  "script"
      +]
    • changedInput schema / properties / to / description
      Previous value: -"The release's tag to write notes for. Default: the latest release. A branch name gives what's merged since `from`."New value: +"The release or plain tag to write notes for. Default: the latest release. A branch name gives what's merged since `from`. In backfill mode: the newest tag of the run; default: the newest tag without a GitHub release."
  2. Added

TDQS

A4.1/5.0
Behavior4/5

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

The annotations already establish read-only, open-world, and idempotent behavior. The description adds useful context beyond that: it works on public repositories, requires no sign-in, is deterministic with no AI, limits backfill to ten tags, and returns a publishing script rather than publishing itself. It does not cover error behavior or rate limits, so it is strong but not exhaustive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose and then covers backfill and return behavior. It is dense and uses long sentences, but every sentence adds relevant capability detail. Slightly better paragraph or bullet structure would improve scanability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex generator with six parameters and no output schema, the description explains the main modes, defaults, returned artifacts, and publishing script behavior. Combined with the complete input schema and safety annotations, an agent has enough information to select and call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all six parameters thoroughly. The description adds some meaning beyond the schema, especially the backfill run cap of ten tags and the default selection of newest unpublished tags, but much of the parameter detail is repeated. The extra behavioral semantics are useful but not extensive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: writing release notes for a release or tag of a public GitHub repository, including Keep a Changelog output, backfill mode, and a generated gh script. It is very clear what the tool does. It does not explicitly differentiate itself from the similarly named sibling generate_release_notes, so it stops short of the top score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear usage context by explaining single versus backfill mode, default ranges, and what output modes produce. It does not explicitly state when to use this tool instead of sibling tools such as generate_release_notes or get_release. The context is strong, but alternative routing is absent.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources