Git Rules MCP Server

Enforce Git workflow rules and prevent repository violations with AI coding assistants.

A Model Context Protocol (MCP) server that validates Git commands against configurable repository rules, providing workflow guidance and preventing common Git mistakes when working with AI coding assistants.

🚀 What It Does

🛡️ Branch Protection: Prevents direct commits/pushes to protected branches (main, master, etc.)
📋 Workflow Validation: Validates Git commands against your repository's workflow rules
🔄 Smart Suggestions: Provides alternative workflows when commands are blocked
📝 Commit Standards: Enforces conventional commit message formats
🧹 Repository Health: Analyzes repository compliance with workflow rules
🤖 AI Integration: Works seamlessly with Claude Code, Cursor, GitHub Copilot, and other AI assistants

🎯 Why You Need This

The Problem

AI coding assistants can accidentally:

Push directly to protected branches
Create commits with poor messages
Bypass your team's Git workflows
Make repository management chaotic

The Solution

This MCP server acts as a gatekeeper that:

✅ Validates every Git operation before execution
✅ Enforces your team's workflow rules consistently
✅ Guides AI assistants to follow proper Git practices
✅ Prevents repository violations before they happen

📦 Quick Install

⚠️ Important: Most users will encounter permission errors with the default npm configuration. Use the Recommended Setup below to avoid issues.

🎯 Recommended Setup (Prevents Permission Errors)

Copy and paste this entire block into your terminal:

# Setup npm user directory and install in one go:
mkdir -p ~/.npm-global && \
npm config set prefix ~/.npm-global && \
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc && \
source ~/.zshrc && \
npm install -g @fraqtiv/git-rules-mcp && \
echo "🎉 Installation complete! Testing..." && \
mcp-git-rules --test

For Bash users, replace ~/.zshrc with ~/.bashrc:

# Bash version:
mkdir -p ~/.npm-global && \
npm config set prefix ~/.npm-global && \
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc && \
source ~/.bashrc && \
npm install -g @fraqtiv/git-rules-mcp && \
echo "🎉 Installation complete! Testing..." && \
mcp-git-rules --test

Expected output after running the above:

🎉 Installation complete! Testing...
🔍 Testing git-rules-mcp installation...
✅ MCP Server: Initialized successfully
✅ Git Repository: Detected (or Not found)
✅ Configuration: Loaded (X protected branches)
🎉 Installation test passed! The MCP server is ready to use.

🔧 Alternative: System-Wide Install (May Need Sudo)

If you prefer system-wide installation and encounter permission errors:

# Only if you get EACCES permission errors:
sudo npm install -g @fraqtiv/git-rules-mcp

# Then test (no sudo needed for testing):
mcp-git-rules --test

🚨 Quick Fixes for Common Issues

Still getting permission errors? Use the one-liner commands above instead of npm install -g directly.

❌ "command not found: mcp-git-rules" after installation? You missed adding npm bin to your PATH. Fix it now:

# Quick fix (copy-paste this):
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc && source ~/.zshrc && mcp-git-rules --test

# Or for Bash:
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc && source ~/.bashrc && mcp-git-rules --test

# Alternative - run with full path once:
~/.npm-global/bin/mcp-git-rules --test

Want to verify installation status?

npm list -g @fraqtiv/git-rules-mcp  # Check if installed
which mcp-git-rules                 # Check if in PATH
mcp-git-rules --help               # Show available options

⚡ Quick Setup by AI Assistant

Choose your AI coding assistant for specific setup instructions:

Assistant	Integration Guide	Setup Complexity
Claude Code	Native MCP support with workflow configuration	⭐⭐⭐
Cursor	MCP + .cursorrules integration	⭐⭐
Warp Terminal	Built-in MCP support with direct server configuration	⭐⭐
GitHub Copilot	Bridge extensions + git hooks	⭐⭐⭐⭐
KILOCODE	Plugin system integration	⭐⭐⭐

💡 Quick Start: Most users should start with the Claude Code guide for the smoothest experience.

🛠️ Basic Configuration

Create .gitrules.yaml in your repository root:

# Protected branches that cannot be directly modified
protectedBranches:
  - main
  - master

# Integration branch where features are merged first  
integrationBranch: dev

# Branch naming conventions
featureBranchPrefix: feature/
hotfixBranchPrefix: hotfix/

# Workflow enforcement
requireCleanWorkingTree: true
allowDirectPush: false
enforceCommitMessageFormat: true

# Conventional commit types
allowedCommitTypes:
  - feat      # New features
  - fix       # Bug fixes  
  - docs      # Documentation
  - style     # Formatting
  - refactor  # Code restructuring
  - test      # Adding tests
  - chore     # Maintenance

🎮 How It Works

1. Repository Status Check

# The MCP server analyzes your repository
Current Branch: feature/user-auth
Status: Clean ✅
Protected: No ✅
Integration Branch: dev

2. Command Validation

# Before: git push origin main
❌ BLOCKED: Direct push to protected branch 'main'
💡 Suggestion: Merge to 'dev' first, then create PR to main

# Proper workflow:
✅ git checkout dev
✅ git merge feature/user-auth  
✅ git push origin dev
✅ Create PR: dev → main

3. Workflow Guidance

# AI Assistant asks: "How do I start a new feature?"
# MCP Server responds:

🚀 Starting New Feature:
1. git checkout dev
2. git pull origin dev  
3. git checkout -b feature/your-feature-name

✅ Ready to begin development!

🔧 Available Tools

The MCP server provides these tools to AI assistants:

Tool	Purpose	Example Use
`get_repository_status`	Check branch, cleanliness, protection status	Before any Git operation
`validate_git_command`	Validate if a Git command is allowed	Before `push`, `commit`, `merge`
`suggest_workflow`	Get step-by-step workflow guidance	Starting features, merging, releases
`analyze_repository_compliance`	Full repository health check	Regular compliance audits

🌟 Key Features

Branch Protection

Protected Branches: Prevent direct commits to main/master
Integration Workflow: Enforce proper merge patterns
Clean Working Tree: Require clean state for protected operations

Commit Standards

Conventional Commits: Enforce type: description format
Type Validation: Only allow configured commit types
Message Quality: Ensure meaningful commit messages

Workflow Automation

Smart Suggestions: Alternative paths when commands blocked
Step-by-Step Guidance: Complete workflow instructions
Safety Checks: Validate before every operation

AI Assistant Integration

Universal Compatibility: Works with any MCP-enabled AI assistant
Real-time Validation: Immediate feedback on Git operations
Educational: Teaches proper Git workflows

📖 Example Workflows

Protected Branch Workflow

main (protected) ← PR ← dev ← merge ← feature/new-auth
                                   ↑
                              You work here

Feature Development Flow

# 1. Start new feature (validated by MCP)
git checkout dev
git pull origin dev
git checkout -b feature/user-authentication

# 2. Development work
git add .
git commit -m "feat: add user login form"
git commit -m "test: add login form tests"

# 3. Feature complete (validated by MCP)  
git checkout dev
git merge feature/user-authentication
git push origin dev

# 4. Production release
# Create PR: dev → main (only way to update main)

🏗️ Advanced Usage

Custom Rules

# .gitrules.yaml - Advanced configuration
protectedBranches:
  - main
  - staging
  - release/*

workflowRules:
  requirePullRequest: true
  requireCodeReview: true
  requireStatusChecks: true
  
branchNaming:
  feature: "feature/JIRA-123-description"
  hotfix: "hotfix/JIRA-456-critical-fix"
  
commitRules:
  maxLength: 72
  requireJiraTicket: true
  allowedScopes: ["auth", "api", "ui", "docs"]

CI/CD Integration

# .github/workflows/validate-git-rules.yml
name: Git Rules Validation
on: [push, pull_request]

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup npm global directory
        run: |
          mkdir -p ~/.npm-global
          npm config set prefix ~/.npm-global
          echo "$HOME/.npm-global/bin" >> $GITHUB_PATH
      - run: npm install -g @fraqtiv/git-rules-mcp
      - run: mcp-git-rules --test

🔍 Advanced Troubleshooting

Installation Issues

⚠️ Most Common Problems: See the Quick Install section above for proactive solutions.

Advanced PATH Configuration

# For different shells:
echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.bashrc   # Bash
echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.zshrc    # Zsh
echo 'set -gx PATH (npm config get prefix)/bin $PATH' >> ~/.config/fish/config.fish  # Fish

# Check current npm prefix:
npm config get prefix

# Check if PATH includes npm global bin:
echo $PATH | grep -q "$(npm config get prefix)/bin" && echo "✅ PATH configured" || echo "❌ PATH missing npm global bin"

Package Installation Issues

# Check installation
npm list -g @fraqtiv/git-rules-mcp

# Reinstall if needed
npm install -g @fraqtiv/git-rules-mcp

Rules Not Being Enforced

See Claude Code Caveats
Ensure project has proper workflow documentation
AI assistants need explicit instruction to use MCP tools

Configuration Not Loading

# Test configuration
mcp-git-rules --config-check

# Validate YAML syntax
mcp-git-rules --validate-config .gitrules.yaml

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

git clone https://github.com/FRAQTIV/gitrules-mcp-server.git
cd gitrules-mcp-server
npm install
npm run build
npm test

📋 Roadmap

Web Dashboard - Visual repository compliance dashboard
Team Analytics - Workflow compliance metrics and reporting
Custom Hooks - Extensible validation system
Integration Templates - Pre-built configurations for popular workflows
Enterprise Features - Advanced compliance and audit logging

📄 License

MIT License - see LICENSE file for details.

🙋 Support & Community

📖 Documentation: Full docs and integration guides
🐛 Issues: GitHub Issues
💬 Discussions: GitHub Discussions
🔗 Website: https://fraqtiv.github.io/gitrules-mcp-server

⭐ Star this repo if it helps keep your Git workflow clean! ⭐

Made with ❤️ by FRAQTIV

Name		Name	Last commit message	Last commit date
Latest commit History 22 Commits
.github/workflows		.github/workflows
.mcp-example		.mcp-example
bin		bin
docs		docs
src		src
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.gitrules.yaml		.gitrules.yaml
.markdownlint.json		.markdownlint.json
CHANGELOG.md		CHANGELOG.md
CLAUDE.md		CLAUDE.md
LICENSE		LICENSE
README.md		README.md
git-workflow-rules.md		git-workflow-rules.md
package-lock.json		package-lock.json
package.json		package.json
service-control.sh		service-control.sh
tsconfig.json		tsconfig.json

License

FRAQTIV/gitrules-mcp-server

Folders and files

Latest commit

History

Repository files navigation