🚀 🌈 Iris MCP 服务器
Iris MCP 服务器是一款强大的工具，它基于 Git 仓库标签自动生成发布说明。借助模型上下文协议构建，能精准解析标签差异，并将结构化的发布说明生成到 .iris 目录，极大提升了发布说明的生成效率。
🚀 快速开始
Iris MCP 服务器可帮助你轻松生成发布说明。首先，你需要安装该工具，然后按照示例代码进行操作，即可快速生成所需的发布说明。
✨ 主要特性
- 🏷️ 自动检测标签间的差异，精准定位版本变化。
- 📊 可自定义的发布说明模板，满足多样化需求。
- 🗂️ 分类整理新功能、改进项、Bug 修复等内容，使发布说明清晰明了。
- 📄 Markdown 格式输出，方便查看和分享。
- 📁 自动生成到
.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: 'Version 1.1.0 发布说明',
features: [
'新增仪表盘功能',
'实现用户管理系统'
],
improvements: [
'性能优化',
'界面改进'
],
bugfixes: [
'修复登录时的错误',
'解决数据同步问题'
],
breaking: [
'API 端点变更',
'配置文件格式更新'
]
});
输出示例
运行上述代码后，将生成如下格式的发布说明：
# Version 1.1.0 发布说明
发布日期：2024-01-20
## 💥 破坏性更改
- API 端点变更
- 配置文件格式更新
## ✨ 新功能
- 新增仪表盘功能
- 实现用户管理系统
## 🔧 改进项
- 性能优化
- 界面改进
## 🐛 修复问题
- 修复登录时的错误
- 解决数据同步问题
## 📝 修改的文件
- `src/dashboard/index.ts`
- `src/users/management.ts`
- `config/settings.json`
🛠️ 开发
构建
使用以下命令进行项目构建：
npm run build
开发模式
若要开启开发模式，可运行以下命令：
npm run watch
🤝 贡献
欢迎通过 Pull Request 或 Issue 提交贡献，具体步骤如下：
- 分叉此仓库。
- 创建新分支 (
git checkout -b feature/amazing-feature)。 - 提交更改 (
git commit -m '✨ 添加精彩功能')。 - 推送分支 (
git push origin feature/amazing-feature)。 - 创建 Pull Request。
📄 许可证
本项目采用 MIT 许可证。
👥 作者
- 创建者: [你的名字]
- 邮箱: [your.email@example.com]