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. 利用可能な場合、プルリクエスト情報を含むコミットデータを充実させる