Release Notes

An MCP server for generating release notes from GitHub commits

typescript

3

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "nickbaumann98-release-notes-server": {
      "command": "node",
      "args": [
        "/path/to/release-notes-server/build/index.js"
      ],
      "env": {
        "GITHUB_TOKEN": "your-github-token"
      }
    }
  }
}

You deploy this MCP server to generate well-structured release notes from GitHub repositories. It fetches commits, groups them by type, enriches with PR data, and outputs clean, markdown-formatted notes with useful statistics for your project releases.

How to use

To use this MCP server with your MCP client, connect the server as a stdio backend that you run locally or as a remote service you call from your MCP tooling. The server exposes a tool that can generate release notes from a GitHub repository, producing a markdown document with sections by commit type and detailed statistics.

How to install

Prerequisites: you need Node.js and npm installed on your machine.

Install dependencies and build the server.

Run the following commands in order:

Configuration example

{
  "mcpServers": {
    "release_notes": {
      "command": "node",
      "args": ["/path/to/release-notes-server/build/index.js"],
      "env": {
        "GITHUB_TOKEN": "your-github-token"
      }
    }
  }
}

Usage notes

Start the server by running the command shown in the config. You can then invoke the available MCP tool to generate release notes for a specified GitHub repository and commit range. The output contains a header with generation date and statistics, sections grouped by commit type, and detailed per-type and per-author counts.

Troubleshooting

If you encounter authentication issues, ensure your GitHub token has repo access and is correctly provided in the environment block. Check that the build step completed successfully before attempting to start the server.

Notes

The server supports efficient data fetching using GitHub's since parameter when possible, with a fallback to SHA-based filtering. It maintains newest-first ordering for release notes and enriches commits with PR data when available.

Available tools

generate_release_notes

Generates release notes for a GitHub repository. It accepts owner, repo, optional commit range, and format options to produce a markdown report grouped by type with optional statistics.