AI GitHub Changelog Generator CLI MCP

AI-github-changelog-generator-cli-mcp 项目介绍

产品定位

AI-github-changelog-generator-cli-mcp 是一个利用 AI 技术从 git 提交记录和工作目录变更中自动生成专业变更日志的工具，旨在简化开发团队的变更管理和发布流程。

核心功能

• 🤖 AI 驱动：使用 GPT-4.1 系列、o3/o4 推理模型，支持智能模型选择
• 🏥 仓库健康评估：全面的健康评估，包括提交质量评分和卫生建议
• 🔧 双模式运行：可作为独立 CLI 或具有完整功能对等的 MCP 服务器
• 📊 全面分析：Git 提交 + 工作目录变更 + 分支 + 悬空提交 + 未跟踪文件
• 📁 文件生成：创建带有适当归属的 AI_CHANGELOG.md 文件
• 🎯 模型覆盖：支持强制使用特定模型（如 --model gpt-4.1）
• 🎮 交互模式：专业的提交选择和分析界面
• ⚡ 零配置：开箱即用，具有智能回退和增强的错误处理
• 🔐 多提供商支持：支持 OpenAI 和 Azure OpenAI 自动检测

适用场景

• 开发团队日常开发中的变更理解
• 代码审查时生成全面的变更摘要
• 发布管理中的专业变更日志生成
• 利益相关者沟通的业务导向变更摘要
• CI/CD 集成中的自动化变更日志生成

工具列表

CLI 工具

• ai-changelog: 生成标准 AI 变更日志
• ai-changelog --detailed: 全面的业务+技术分析
• ai-changelog --enterprise: 企业级文档格式
• ai-changelog --analyze: 分析当前变更
• ai-changelog --branches: 分析所有分支和未合并提交
• ai-changelog --comprehensive: 完整的仓库健康检查
• ai-changelog --untracked: 分类未跟踪文件
• ai-changelog --interactive: 交互式提交选择
• ai-changelog --health: 全面的仓库健康报告

MCP 服务器工具

• generate_changelog: 从提交生成 AI 变更日志并写入文件
• generate_changelog_from_changes: 从工作目录变更生成 AI 变更日志并写入文件
• assess_repository_health: 全面的仓库健康评估
• analyze_commits: 分析提交模式
• analyze_current_changes: 分析暂存/未暂存文件
• analyze_branches: 分支和未合并分析
• analyze_comprehensive: 完整的仓库健康分析
• get_git_info: 仓库信息
• configure_ai_provider: 测试 AI 提供商设置
• validate_models: 检查模型可用性

常见问题解答

常见问题

1. "No API key found"

创建 .env.local 文件并添加您的凭据

1. "No commits found"

检查是否有提交记录，或尝试指定范围

1. "Model not available"

检查可用模型或尝试不同的模型

1. 测试配置

使用 ai-changelog --validate 或 npm run config:validate 检查配置

使用教程

使用依赖

• Node.js 18+
• Git 仓库
• API 密钥 用于 OpenAI 或 Azure OpenAI（可选）

安装教程

# 全局安装 CLI 使用
npm install -g ai-github-changelog-generator-cli-mcp

# 或在项目中本地安装
npm install ai-github-changelog-generator-cli-mcp

基本使用

# 生成变更日志（全局安装）
ai-changelog

# 或使用 npm 脚本（本地安装）
npm run changelog

# 启动 MCP 服务器（全局安装）
ai-changelog-mcp

# 或使用 npm 脚本（本地安装）
npm run mcp

调试方式

# 验证配置（全局安装）
ai-changelog --validate

# 分析当前变更（全局安装）
ai-changelog --analyze

# 查看所有选项（全局安装）
ai-changelog --help

# 本地安装调试
npm run config:validate
npm run changelog:analyze
npm run changelog -- --help

配置

环境变量

# OpenAI
export OPENAI_API_KEY="your-key"

# Azure OpenAI（推荐 - 支持推理模型）
export AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com"
export AZURE_OPENAI_KEY="your-key"
export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-4.1"
export AZURE_OPENAI_API_VERSION="2025-04-01-preview"

.env.local 文件

在项目根目录创建 .env.local 文件：

AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com
AZURE_OPENAI_KEY=your-key
AZURE_OPENAI_DEPLOYMENT_NAME=gpt-4.1
AZURE_OPENAI_API_VERSION=2025-04-01-preview