Sunwood Ai Labs Release Notes Generator Iris MCP Server

🚀 🌈 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]