Commit Messages MCP Server

An MCP server that helps generate high-quality commit messages based on file changes.

Features

• Convention Detection: Automatically detects the commit message convention used based on sample commit messages
• Change Analysis: Analyzes file changes to determine the type and scope of changes
• Breaking Change Detection: Identifies potential breaking changes in your code
• AI-Powered Message Generation: Uses Google's Gemini AI to generate commit messages that follow your project's conventions

Prerequisites

• Node.js 18 or higher
• Google Gemini API key

Installation

# Clone the repository
git clone https://github.com/yourusername/commit-messages.git
cd commit-messages

# Install dependencies
npm install

# Build the project
npm run build

Configuration

Set your Gemini API key as an environment variable:

export GEMINI_API_KEY=your_api_key_here

Or create a .env file in the project root:

GEMINI_API_KEY=your_api_key_here

Usage with Claude Desktop

1. Add the server to your Claude Desktop configuration file:

{
    "mcpServers": {
        "commit-messages": {
            "command": "node",
            "args": ["/path/to/commit-messages/build/index.js"],
            "env": {
                "GEMINI_API_KEY": "your_api_key_here"
            }
        }
    }
}

2. Restart Claude Desktop
3. Ask Claude to generate a commit message using the provided tools

Example prompts:

• "Generate a commit message for these changes"
• "What commit convention is used in these sample messages?"
• "Analyze these file changes"
• "Check for breaking changes in this diff"

Available Tools

The server provides the following tools:

detect-convention

Detects the commit message convention used based on sample commit messages.

Parameters:

• commit_messages: Sample of previous commit messages

analyze-changes

Analyzes changes in files.

Parameters:

• file_status: Output of git status or similar showing changed files
• diff_content: Output of git diff or similar showing the actual changes
• note (optional): Additional context about the changes

detect-breaking-changes

Detects breaking changes in files.

Parameters:

• file_status: Output of git status or similar showing changed files
• diff_content: Output of git diff or similar showing the actual changes
• note (optional): Additional context about the changes

generate-commit-message

Generates a commit message based on changes.

Parameters:

• file_status: Output of git status or similar showing changed files
• diff_content: Output of git diff or similar showing the actual changes
• commit_messages: Sample of previous commit messages
• note (optional): Additional context about the changes

Development

# Run in development mode
npm run dev

# Build the project
npm run build

# Start the server
npm start

License

MIT