README.md
mcp-server-git: A git MCP server
Overview
A Model Context Protocol server for Git repository interaction and automation. This server provides tools to read, search, and manipulate Git repositories via Large Language Models.
Please note that mcp-server-git is currently in early development. The functionality and available tools are subject to change and expansion as we continue to develop and improve the server.
Tools
git_status
- Shows the working tree status
- Input:
repo_path
(string): Path to Git repository
- Returns: Current status of working directory as text output
git_diff_unstaged
- Shows changes in working directory not yet staged
- Input:
repo_path
(string): Path to Git repository
- Returns: Diff output of unstaged changes
git_diff_staged
- Shows changes that are staged for commit
- Input:
repo_path
(string): Path to Git repository
- Returns: Diff output of staged changes
git_commit
- Records changes to the repository
- Inputs:
repo_path
(string): Path to Git repositorymessage
(string): Commit message
- Returns: Confirmation with new commit hash
git_add
- Adds file contents to the staging area
- Inputs:
repo_path
(string): Path to Git repositoryfiles
(string[]): Array of file paths to stage
- Returns: Confirmation of staged files
git_reset
- Unstages all staged changes
- Input:
repo_path
(string): Path to Git repository
- Returns: Confirmation of reset operation
git_log
- Shows the commit logs
- Inputs:
repo_path
(string): Path to Git repositorymax_count
(number, optional): Maximum number of commits to show (default: 10)
- Returns: Array of commit entries with hash, author, date, and message
git_create_branch
- Creates a new branch
- Inputs:
repo_path
(string): Path to Git repositorybranch_name
(string): Name of the new branchstart_point
(string, optional): Starting point for the new branch
- Returns: Confirmation of branch creation
Installation
Using uv (recommended)
When using uv
no specific installation is needed. We will
use uvx
to directly run mcp-server-git.
Using PIP
Alternatively you can install mcp-server-git
via pip:
pip install mcp-server-git
After installation, you can run it as a script using:
python -m mcp_server_git
Configuration
Usage with Claude Desktop
Add this to your claude_desktop_config.json
:
Using uvx
"mcpServers": {
"git": {
"command": "uvx",
"args": ["mcp-server-git", "--repository", "path/to/git/repo"]
}
}
Using pip installation
"mcpServers": {
"git": {
"command": "python",
"args": ["-m", "mcp_server_git", "--repository", "path/to/git/repo"]
}
}
Usage with Zed
Add to your Zed settings.json:
Using uvx
"context_servers": [
"mcp-server-git": {
"command": {
"path": "uvx",
"args": ["mcp-server-git"]
}
}
],
Using pip installation
"context_servers": {
"mcp-server-git": {
"command": {
"path": "python",
"args": ["-m", "mcp_server_git"]
}
}
},
Debugging
You can use the MCP inspector to debug the server. For uvx installations:
npx @modelcontextprotocol/inspector uvx mcp-server-git
Or if you've installed the package in a specific directory or are developing on it:
cd path/to/servers/src/git
npx @modelcontextprotocol/inspector uv run mcp-server-git
Running tail -n 20 -f ~/Library/Logs/Claude/mcp*.log
will show the logs from the server and may
help you debug any issues.
Development
If you are doing local development, there are two ways to test your changes:
Run the MCP inspector to test your changes. See Debugging for run instructions.
Test using the Claude desktop app. Add the following to your
claude_desktop_config.json
:
"git": {
"command": "uv",
"args": [
"--directory",
"/<path to mcp-servers>/mcp-servers/src/git",
"run",
"mcp-server-git"
]
}
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.
Git
A Model Context Protocol server for Git repository interaction and automation. This server provides tools to read, search, and manipulate Git repositories via Large Language Models.