MCP Git

🚀 Git Command MCP Server

This is a Model Context Protocol (MCP) server that provides a tool for executing various Git commands.

It requires the local installation of the git (git.exe) command.

Since most of this project was created by generative AI, please contact http://github.com/ukiuni/mcp-git if you find any issues.

🚀 Quick Start

📦 Installation

Clone the Repository Using Git

1. Clone the repository (if you haven't already):

   git clone http://github.com/ukiuni/mcp-git.git
   cd mcp-git
   

2. Install dependencies: Make sure you have Node.js and npm installed. Then run:

   npm install
   

Install Using npm

1. Install using npm.

   npm i mcp-git
   

   It will be installed in the node_modules directory, so please set the relevant path for the next step.

Connect from an MCP Client

When connecting from an MCP client (e.g., Roo Code, GitHub Copilot, Claude Desktop, Cursor, etc.), use the following settings.

{
  "mcpServers": {
    "mpc-git": {
      "command": "node",
      "args": [
        "/path_to_mcp-git/mcp-git/dist/index.js"
      ]
    }
  }
}

Please set path_to_mcp to the absolute path of the directory where you cloned the git repository.

💻 Usage Examples

Available Tools

Each tool name follows the format of the git- prefix plus the command name (e.g., git-add, git-commit, git-status).

Tool Output

The execution results of the tools are returned as text content, usually including:

• STDOUT: The standard output of the Git command.
• STDERR: The standard error output of the Git command (Note: In Git, stderr does not necessarily indicate an error).
• ERROR: Execution errors that occur inside the server.

If the command succeeds and has no output, a success message will be displayed.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Trademarks

Trademarks mentioned in this project are the trademarks of their respective companies.