Git Auto Commit

🚀 Git Auto Commit Server 🛠️

This implementation offers a Git change analyzer that uses OpenAI's GPT model to generate commit messages.

🎥 Demo

✨ Features

• Analyze changes in a Git repository (including staged and unstaged changes).
• Generate conventional commit messages using the GPT-4o-mini model.
• Detailed summary:
  • 📝 Modified files.
  • ✨ Newly added files.
  • 🗑️ Deleted files.
  • 📄 Detailed changes in files (up to 10 lines per file).
• Built with @modelcontextprotocol/sdk.
• Add an automatic signature to each commit.

📁 Project Structure

mcp-server-auto-commit/
├── index.ts        # Main server implementation file, containing Git analysis tools.
├── package.json    # Project dependency management.
├── tsconfig.json   # TypeScript configuration file.
└── build/         # Compiled JavaScript output files.

📋 Prerequisites

• Node.js installed.
• OpenAI API key.
• A Git repository to analyze.
• pnpm package manager.

🚀 Quick Start

1. Clone this repository:

git clone https://github.com/jatinsandilya/mcp-server-auto-commit.git
cd mcp-server-auto-commit

2. Install dependencies:

pnpm install

3. Set up the OpenAI API key using one of the following methods:

   • As an environment variable: OPENAI_API_KEY=your-api-key.
   • Pass it as a command-line argument: --key your-api-key.
   • Add it to the .env file in the project root directory.

4. Build the project:

pnpm run build

This will generate the /build/index.js file, which is your compiled MCP server script.

💻 Using Cursor

1. Open Settings -> MCP -> Add a new MCP server.
2. Configure your MCP:
   • Name: git-auto-commit.
   • Type: Command.
   • Command: node ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js --key your-api-key (Replace your-api-key with your actual OpenAI API key if it's not set as an environment variable).

💻 Using Claude Desktop

Add the following MCP configuration to your Claude Desktop settings:

{
  "mcpServers": {
    "git-auto-commit": {
      "command": "node",
      "args": ["ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js", "--key", "your-api-key"]
    }
  }
}

🛠️ Available Tools

git-changes-commit-message

This tool analyzes changes in the current Git repository and uses OpenAI's GPT-4o-mini model to generate commit messages. It provides:

• A list of modified files with status indicators.
• A list of newly added files.
• A list of deleted files.
• Detailed changes in each file (up to 10 lines per file).
• Generated commit messages that follow the conventional commit format.
• Automatic commit signatures.

Usage parameters:

• autoCommitPath: An optional path to specify the specific path to analyze.

📁 Project Structure Explanation

mcp-server-auto-commit/
├── index.ts        # Main server implementation file, containing Git analysis tools.
├── package.json    # Project dependency management.
├── tsconfig.json   # TypeScript configuration file.
└── build/         # Compiled JavaScript output files.

💡 How to Use

📦 Install Dependencies

pnpm install

🏗️ Build the Project

pnpm run build

▶️ Run the Server

After building, run the generated executable file (which varies depending on the platform).

🚀 Example Usage

Run in the terminal:

node build/index.js

This will start the MCP server and listen for requests from integrated tools.

⚠️ Important Note

• Ensure that you have the latest versions of Node.js and pnpm installed.
• Verify that your OpenAI API key is valid.
• Check your firewall settings to ensure that the server can access the internet.

🤝 Contribution Guidelines

Contributions are welcome! Please fork this repository and submit a pull request.

📄 License

[License information to be filled in here]

📞 Contact

If you need to contact us, please send an email to [your.email@example.com] or visit the project homepage.