Release Notes Generator Iris MCP Server

🚀 🌈 Iris MCP 服务器

Iris MCP 服务器是一个基于 Git 仓库标签的自动化工具，它遵循 Model Context Protocol（MCP），能够自动解析标签间的差异，生成结构化的发布说明，并保存到 .iris 目录中，为项目发布提供便利。

🚀 快速开始

Iris MCP 服务器是一个强大的工具，它可以根据 Git 仓库的标签差异，自动生成详细的发布说明。以下是关于它的安装和使用方法。

✨ 主要特性

• 🏷️ 自动检测标签间的差异：精准找出不同版本标签之间的代码变化。
• 📊 可定制的发布说明模板：支持根据项目需求定制发布说明的格式和内容。
• 🗂️ 分类整理新功能、改进项和 bug 修复：将代码变更清晰分类，方便查看。
• 📄 Markdown 格式输出：生成的发布说明以 Markdown 格式呈现，易于阅读和分享。
• 📁 .iris 文件夹自动保存：将生成的发布说明自动保存到 .iris 文件夹中，便于管理。

📦 安装指南

使用以下命令安装 Iris MCP 服务器：

npm install iris-mcp-server

💻 使用示例

基础用法

以下是生成发布说明的示例代码：

const result = await mcpClient.useTool('iris-mcp-server', 'generate_release_note', {
  startTag: 'v1.0.0',
  endTag: 'v1.1.0',
  title: '版本 1.1.0 发布',
  features: [
    '新增仪表盘功能',
    '实现用户管理系统'
  ],
  improvements: [
    '性能优化',
    'UI 改进'
  ],
  bugfixes: [
    '修复登录时的错误',
    '解决数据同步问题'
  ],
  breaking: [
    'API 端点变更',
    '配置文件格式更新'
  ]
});

输出示例

生成的发布说明会以 Markdown 格式呈现，如下所示：

# 版本 1.1.0 发布说明

发布日期: 2024-01-20

## 💥 破坏性更改

- API 端点变更
- 配置文件格式更新

## ✨ 新功能

- 新增仪表盘功能
- 实现用户管理系统

## 🔧 改进项

- 性能优化
- UI 改进

## 🐛 修复的错误

- 修复登录时的错误
- 解决数据同步问题

## 📝 已修改文件

- `src/dashboard/index.ts`
- `src/users/management.ts`
- `config/settings.json`

🛠️ 开发

构建

使用以下命令进行项目构建：

npm run build

开发模式

若要开启开发模式，可使用以下命令：

npm run watch

🤝 贡献

欢迎通过 pull request 或 issue 为项目做出贡献！具体步骤如下：

1. Fork 此仓库。
2. 创建新分支 (git checkout -b feature/amazing-feature)。
3. 提交变更 (git commit -m '✨ 添加精彩功能')。
4. 推送分支 (git push origin feature/amazing-feature)。
5. 创建 pull request。

📄 许可证

本项目采用 MIT 许可证。

👥 作者

• 开发者: [Your Name]
• 邮件: [your.email@example.com]