Release Notes Server

🚀 Release Notes Generation Server

A MCP server that can intelligently generate beautiful release notes from GitHub repositories. It efficiently fetches commit records, organizes them by type, and presents them in a clean and readable format.

🚀 Quick Start

The Release Notes Generation Server is a powerful tool for generating detailed and organized release notes from GitHub repositories. It streamlines the process of aggregating and presenting commit information.

✨ Features

• 🎯 Intelligently filter commits by date or SHA.
• 📊 Group commits by type (features, fixes, etc.).
• 🔍 Enrich commit data with pull request information.
• 📈 Include detailed statistics.
• 🎨 Present in clean Markdown format with emojis.
• ⚡ Efficiently use the GitHub API with the since parameter.

📦 Installation

npm install
npm run build

💻 Usage Examples

Basic Usage

Add this server to your MCP configuration:

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

Advanced Usage

generate_release_notes

Generate release notes for a GitHub repository.

Parameters:

{
  "owner": string,           // Repository owner
  "repo": string,           // Repository name
  "commitRange": {
    "fromCommit"?: string,  // Starting commit SHA
    "toCommit"?: string    // Ending commit SHA
  },
  "format": {
    "type": "markdown",     // Output format
    "groupBy": "type",      // Grouping method
    "includeStats": boolean // Whether to include statistics
  }
}

Example:

const result = await use_mcp_tool({
  server_name: "release-notes",
  tool_name: "generate_release_notes",
  arguments: {
    owner: "owner",
    repo: "repo",
    commitRange: {
      fromCommit: "abc123" // Fetch commits starting from this SHA
    },
    format: {
      type: "markdown",
      groupBy: "type",
      includeStats: true
    }
  }
});

📚 Documentation

Output Format

The generated release notes include:

1. A header with the generation date and statistics.

2. Sections grouped by type:

   • 🚀 Features
   • 🐛 Fixes
   • 📚 Documentation
   • ⚡ Performance Improvements
   • ♻️ Refactoring
   • 🧪 Testing
   • 🏗️ Build
   • 🔧 Others

3. Detailed statistics including:

   • Total number of commits
   • Breaking changes
   • Commits classified by type
   • Commits classified by author

Environment Variables

• GITHUB_TOKEN: A GitHub personal access token with repository access permissions.

🔧 Technical Details

The server efficiently fetches commits in the following ways:

1. Use GitHub's since parameter whenever possible to reduce API calls.
2. Fall back to SHA-based filtering when necessary.
3. Handle pagination correctly.
4. Maintain the latest priority order for release notes.
5. Enrich commit data with pull request information when available.