🚀 🌈 Iris MCP 服务器
Iris MCP 服务器是一款遵循 Model Context Protocol 协议的工具，它能基于 Git 仓库标签，自动解析标签间的差异，生成结构化的发布说明，并保存到 .iris 文件夹中。
🚀 快速开始
Iris MCP 服务器操作简便，能快速为你生成所需的发布说明。下面将为你介绍安装和使用的基本步骤。
✨ 主要特性
- 🏷️ 自动检测标签间的差异，精准定位版本变化。
- 📊 可定制的发布说明模板，满足多样化需求。
- 🗂️ 对新功能、改进项和错误修复进行分门别类，清晰展示更新内容。
- 📄 以 Markdown 格式输出，方便查看和分享。
- 📁 自动保存到
.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
贡献指南
欢迎通过拉取请求或问题进行贡献！具体步骤如下：
- 分叉此仓库。
- 创建新分支 (
git checkout -b feature/amazing-feature)。 - 提交更改 (
git commit -m '✨ 添加神奇功能')。 - 推送到原点 (
git push origin feature/amazing-feature)。 - 创建拉取请求。
📄 许可证
本项目采用 MIT 许可证。
👥 作者
- 作者: [你的名字]
- 邮箱: [your.email@example.com]