Release Notes Server

🚀 發佈說明生成服務器

發佈說明生成服務器是一個MCP服務器，它能夠從GitHub倉庫中智能生成美觀的發佈說明。該服務器可高效獲取提交記錄，按類型組織這些記錄，並以整潔易讀的格式呈現，為用戶提供便利。

✨ 主要特性

• 🎯 可按日期或SHA智能過濾提交，精準定位所需信息。
• 📊 提交按類型分組，如功能、修復等，方便查看和管理。
• 🔍 豐富提交數據，包含拉取請求信息，提供更全面的內容。
• 📈 包含詳細統計信息，助您瞭解項目的整體情況。
• 🎨 以清潔的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,           // 倉庫所有者
  "repo": string,           // 倉庫名稱
  "commitRange": {
    "fromCommit"?: string,  // 起始提交SHA
    "toCommit"?: string    // 結束提交SHA
  },
  "format": {
    "type": "markdown",     // 輸出格式
    "groupBy": "type",      // 按何種方式分組
    "includeStats": boolean // 是否包含統計信息
  }
}

示例：

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
    }
  }
});

📚 詳細文檔

輸出格式

生成的發佈說明包含：

1. 頭部，包括生成日期和統計信息。
2. 按類型分組的章節：
   • 🚀 功能
   • 🐛 修復
   • 📚 文檔
   • ⚡ 性能改進
   • ♻️ 重構
   • 🧪 測試
   • 🏗️ 構建
   • 🔧 其他
3. 詳細統計信息包括：
   • 總提交數
   • 破壞性變更
   • 按類型分類的提交
   • 按作者分類的提交

環境變量

• GITHUB_TOKEN: 具備倉庫訪問權限的GitHub個人訪問令牌

🔧 技術細節

該服務器通過以下方式實現高效獲取提交：

1. 儘可能使用GitHub的since參數以減少API調用。
2. 在需要時回退到SHA基於過濾。
3. 正確處理分頁。
4. 維持最新的優先順序以用於發佈說明。
5. 當可用時豐富提交數據包含拉取請求信息。