Release Notes Server

Release Notes Server

一个可从 GitHub 仓库生成精美发布说明的 MCP 服务。它可以高效获取提交记录，按类型整理，并以清晰易读的格式呈现。

功能

• 🎯 按日期或 SHA 智能筛选提交
• 📊 按类型对提交分组（功能、修复等）
• 🔍 使用 PR 数据丰富提交信息
• 📈 包含详细统计信息
• 🎨 简洁的 Markdown 格式，并配有表情符号
• ⚡ 使用 GitHub 的 since 参数高效调用 API

安装

npm install
npm run build

使用方法

将此服务添加到 MCP 配置中：

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

可用工具

generate_release_notes

为 GitHub 仓库生成发布说明。

参数：

{
  "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",      // How to group commits
    "includeStats": boolean // Include commit statistics
  }
}

示例：

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

输出格式

生成的发布说明包括：

1. 包含生成日期和统计信息的标题

2. 按提交类型分组的章节：

   • 🚀 功能
   • 🐛 修复
   • 📚 文档
   • ⚡ 性能
   • ♻️ 重构
   • 🧪 测试
   • 🏗️ 构建
   • 🔧 其他

3. 详细统计信息，包括：

   • 提交总数
   • 破坏性变更
   • 按类型统计的提交
   • 按作者统计的提交

环境变量

• GITHUB_TOKEN：具有仓库访问权限的 GitHub 个人访问令牌

实现细节

此服务通过以下方式高效获取提交记录：

1. 尽可能使用 GitHub 的 since 参数来减少 API 调用
2. 必要时回退到基于 SHA 的筛选
3. 正确处理分页
4. 为发布说明保持从新到旧的排序
5. 在有可用 PR 数据时，使用其丰富提交信息

许可证

MIT