Git Mob

What is git-mob-mcp-server?

git-mob-mcp-server is a Node.js server that implements the Model Context Protocol (MCP) to interface with the git-mob CLI app. It helps developers manage co-authors for Git commits, particularly useful for pair and mob programming sessions. It automates the process of adding "Co-authored-by" trailers to commit messages, ensuring proper attribution for multiple contributors.

How to use git-mob-mcp-server?

To use git-mob-mcp-server, you need to have Node.js (v18+), Git (v2.32+), and the git-mob CLI app installed. The server can be integrated with tools like Claude Desktop or VS Code by configuring them to use npx git-mob-mcp-server as an MCP server. After setup, you interact with it through the git-mob CLI, using its commands to manage team members and set up mob sessions.

Key Features of git-mob-mcp-server

• Setup git-mob CLI: Facilitates the initial setup of the git-mob CLI.
• Team Member Management: Allows adding, deleting, and listing team members with their keys, names, and emails.
• Session Management: Enables choosing and setting active co-authors for pairing or mobbing sessions.
• Automatic Co-author Appending: Automatically appends "Co-authored-by" trailers to commit messages during active pairing/mobbing sessions.
• Session Clearing: Provides functionality to clear active mob or pairing sessions.
• Co-author Trailer Listing: Lists the formatted "Co-authored-by" trailers for current co-authors.

Use Cases of git-mob-mcp-server

• Pair Programming: Easily attribute commits to two developers working on the same code.
• Mob Programming: Ensure all participants in a mob programming session are credited for their contributions.
• Streamlined Git Workflow: Automate the often manual process of adding co-author information to commit messages.
• Team Collaboration: Facilitate better collaboration and attribution in team-based development environments.

FAQ from git-mob-mcp-server

Q: What are the system requirements for git-mob-mcp-server? A: You need Node.js v18 or higher, Git v2.32 or later, and the git-mob CLI app installed.

Q: How do I set up git-mob-mcp-server? A: After installing the prerequisites, you can integrate it with your preferred editor (e.g., VS Code) or desktop application (e.g., Claude Desktop) by configuring them to run npx git-mob-mcp-server. You also need to run the setup_git_mob MCP tool once.

Q: Can I use git-mob-mcp-server for local development? A: Yes, you can clone the repository, install dependencies, and run npm start to start a development server with an MCP Inspector for testing and debugging.

Git Mob MCP Server

Node.js server implementing Model Context Protocol (MCP) for git mob CLI app

You can attribute a git commit to more than one author by adding one or more Co-authored-by trailers to the commit's message. Co-authored commits are visible on GitHub. For more information, see here.

This MCP Server will help you add them automatically and also help you store and manage co-authors for pair/mob programming sessions.

Built using @modelcontextprotocol/sdk

Features

• Setup git mob CLI
• Add / delete / list team members
• Choose team members for pairing / mobbing session
• Automatic appending of Co-authored-by in for co-authors in commit messages during pairing / mobbing session

Prerequisites

System Requirements

• Node.js: Version 18 or higher
• git: Git v2.32 or later must be installed and configured
• git-mob CLI: git-mob CLI app must be installed

API

Resources

• git_mob_cli_help: General help and usage information for the Git Mob CLI.
• git_mob_cli_version: The installed version of the Git Mob CLI.

Tools

• setup_git_mob: Sets up git-mob globally for the user.
• setup_git_mob_locally: Sets up git-mob locally for the current repository when it overrides core.hooksPath git configuration variable (e.g when using husky).
• add_team_member: Adds a new team member using their key, name, and email.
• delete_team_member: Deletes a team member by their key.
• list_team_members: Lists all team members that have been added to Git Mob.
• set_mob_session_coauthors: Sets the active pairing or mob session by specifying the keys of the team members to include as coauthors.
• clear_mob_session: Clears the active mob or pairing session.
• list_mob_session_coauthors: Lists all coauthors currently included in the active mob or pairing session.
• list_mob_session_coauthor_trailers: Lists the git Co-authored-by trailers for the coauthors currently included in the active mob or pairing session.
• get_git_mob_cli_help: Displays general help and usage information for the Git Mob CLI.

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

NPX

{
  "mcpServers": {
    "git-mob": {
      "command": "npx",
      "args": ["-y", "git-mob-mcp-server"]
    }
  }
}

Usage with VS Code

For installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open Settings (JSON).

Optionally, you can add it to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

Note that the mcp key is not needed in the .vscode/mcp.json file.

NPX

{
  "mcp": {
    "servers": {
      "git-mob": {
        "command": "npx",
        "args": ["-y", "git-mob-mcp-server"]
      }
    }
  }
}

Setup

Run the setup_git_mob MCP tool once to setup git-mob before using other tools

Local Development

For local development and testing of the MCP server:

1. Clone the repository:

   git clone https://github.com/Mubashwer/git-mob-mcp-server.git
   cd git-mob-mcp-server
   

2. Install dependencies:

   npm install
   

3. Start development server:

   npm start
   

   This command will:

   • Build the TypeScript source code in watch mode (automatically rebuilds on file changes)
   • Start the MCP Inspector for testing and debugging the server locally

The MCP Inspector will be available at the URL shown in the terminal output, allowing you to test the server's tools and resources interactively.

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.