Release Notes Server (发布说明服务器)

一个 MCP 服务器，用于从 GitHub 仓库生成美观的发布说明。它能高效地获取提交记录 (commits)，按类型组织它们，并以清晰易读的格式呈现。

Features (特性)

• 🎯 通过日期或 SHA 智能过滤提交记录
• 📊 按类型分组提交记录 (特性、修复等)
• 🔍 使用 PR 数据丰富提交记录
• 📈 包含详细的统计信息
• 🎨 带有 emojis 的简洁 markdown 格式
• ⚡ 通过 GitHub 的 since 参数高效使用 API

Installation (安装)

npm install
npm run build

Usage (使用)

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

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

Available Tools (可用工具)

generate_release_notes

为 GitHub 仓库生成发布说明。

Parameters (参数):

{
  "owner": string,           // 仓库所有者
  "repo": string,           // 仓库名称
  "commitRange": {
    "fromCommit"?: string,  // 起始提交 SHA
    "toCommit"?: string    // 结束提交 SHA
  },
  "format": {
    "type": "markdown",     // 输出格式
    "groupBy": "type",      // 如何分组提交记录
    "includeStats": boolean // 是否包含提交统计信息
  }
}

Example (示例):

const result = await use_mcp_tool({
  server_name: "release-notes",
  tool_name: "generate_release_notes",
  arguments: {
    owner: "owner",
    repo: "repo",
    commitRange: {
      fromCommit: "abc123" // 从此 SHA 获取提交记录
    },
    format: {
      type: "markdown",
      groupBy: "type",
      includeStats: true
    }
  }
});

Output Format (输出格式)

生成的发布说明包括：

1. 带有生成日期和统计信息的标题

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

   • 🚀 Features (特性)
   • 🐛 Fixes (修复)
   • 📚 Documentation (文档)
   • ⚡ Performance (性能)
   • ♻️ Refactoring (重构)
   • 🧪 Tests (测试)
   • 🏗️ Build (构建)
   • 🔧 Other (其他)

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

   • Total commits (总提交数)
   • Breaking changes (重大变更)
   • Commits by type (按类型的提交数)
   • Commits by author (按作者的提交数)

Environment Variables (环境变量)

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

Implementation Details (实现细节)

该服务器通过以下方式实现高效的提交记录获取：

1. 尽可能使用 GitHub 的 since 参数来减少 API 调用
2. 在需要时回退到基于 SHA 的过滤
3. 正确处理分页
4. 保持发布说明的最新优先排序
5. 在可用时使用 PR 数据丰富提交记录

License (许可证)

MIT