Release Notes Generator Iris MCP Server

🚀 Iris MCP Server

Iris MCP Server is a Model Context Protocol (MCP) server that automatically generates release notes based on Git repository tags. By analyzing the differences between tags, it can automatically generate structured release notes and save them in the .iris directory.

🚀 Quick Start

Installation

npm install iris-mcp-server

Usage

Generate Release Notes

const result = await mcpClient.useTool('iris-mcp-server', 'generate_release_note', {
  startTag: 'v1.0.0',
  endTag: 'v1.1.0',
  title: 'Version 1.1.0 Release',
  features: [
    'New dashboard feature added',
    'User management system implemented'
  ],
  improvements: [
    'Performance optimization',
    'UI improvement'
  ],
  bugfixes: [
    'Login error fixed',
    'Data synchronization issue resolved'
  ],
  breaking: [
    'API endpoint changes',
    'Configuration file format updated'
  ]
});

✨ Features

• 🏷️ Automatically detect differences between tags
• 📊 Customizable release note templates
• 🗂️ Categorize new features, improvements, and bug fixes
• 📄 Output in Markdown format
• 📁 Automatically save to the .iris folder

💻 Usage Examples

Basic Usage

const result = await mcpClient.useTool('iris-mcp-server', 'generate_release_note', {
  startTag: 'v1.0.0',
  endTag: 'v1.1.0',
  title: 'Version 1.1.0 Release',
  features: [
    'New dashboard feature added',
    'User management system implemented'
  ],
  improvements: [
    'Performance optimization',
    'UI improvement'
  ],
  bugfixes: [
    'Login error fixed',
    'Data synchronization issue resolved'
  ],
  breaking: [
    'API endpoint changes',
    'Configuration file format updated'
  ]
});

Output Example

# Version 1.1.0 Release Notes

Release Date: 2024-01-20

## 💥 Breaking Changes

- API endpoint changes
- Configuration file format updated

## ✨ New Features

- New dashboard feature added
- User management system implemented

## 🔧 Improvements

- Performance optimization
- UI improvement

## 🐛 Bug Fixes

- Login error fixed
- Data synchronization issue resolved

## 📝 Modified Files

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

🛠️ Development

Build

npm run build

Development Mode

npm run watch

🤝 Contribution

Contributions are welcome via pull requests or issues! Here are the steps:

1. Fork this repository.
2. Create a new branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m '✨ Add amazing feature').
4. Push the branch (git push origin feature/amazing-feature).
5. Create a pull request.

📄 License

MIT

👥 Authors

• Developer: [Your Name]
• Email: [your.email@example.com]