🚀 🌈 Iris MCP 服务器

Iris MCP 服务器是一款遵循 Model Context Protocol 协议的工具，它能够基于 Git 仓库标签自动生成发布说明。通过解析标签间的差异，生成结构化的发布说明并保存到 .iris 文件夹中，为项目发布管理提供了便利。

🚀 快速开始

Iris MCP 服务器使用简单，能帮助你快速生成规范的发布说明。首先，你需要进行安装，然后就可以按照示例代码生成发布说明。

✨ 主要特性

• 🏷️ 自动检测标签间的差异：自动识别 Git 仓库中不同标签之间的变化，为生成发布说明提供数据基础。
• 📊 可定制的发布说明模板：支持根据项目需求定制发布说明的模板，满足多样化的展示需求。
• 🗂️ 分门别类的新功能、改进项和错误修复：将发布内容清晰地分为新功能、改进项、错误修复和破坏性变更等类别，使发布说明更加清晰明了。
• 📄 Markdown 格式输出：生成的发布说明以 Markdown 格式输出，方便在各种平台上展示和分享。
• 📁 自动保存到 .iris 文件夹：生成的发布说明会自动保存到 .iris 文件夹中，便于管理和查找。

📦 安装指南

使用以下命令进行安装：

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 端点更改',
    '配置文件格式更新'
  ]
});

输出示例

生成的发布说明示例如下：

# 版本 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

🤝 贡献指南

欢迎大家通过拉取请求或问题进行贡献，具体步骤如下：

1. 叉取此仓库。
2. 创建新分支 (git checkout -b feature/amazing-feature)。
3. 提交更改 (git commit -m '✨ 添加神奇功能')。
4. 推送到原点 (git push origin feature/amazing-feature)。
5. 创建拉取请求。

📄 许可证

本项目采用 MIT 许可证。

👥 作者

• 作者: [你的名字]
• 邮箱: [your.email@example.com]