🚀 PR Buddy - AI-Powered Pull Request Assistant

📑 Table of Contents

• 🎯 Overview
• ✨ Key Features
• 📁 Repository Structure
• 🚀 Quick Start
• 📖 Documentation
• 💡 Usage Examples
• 🤝 Contributing
• 📄 License

🎯 Overview

PR Buddy is an advanced AI-powered pull request management system that seamlessly integrates with your development workflow through the Model Context Protocol (MCP). It combines four powerful MCP servers with intelligent AI rules to automate and enhance your PR lifecycle - from creation through review to merging.

What Makes PR Buddy Special?

• 🤖 AI-Driven Automation - Intelligent PR creation, review, and updates using Cursor's AI agents
• 🔒 Security-First - Built-in CVE scanning and vulnerability detection
• 🔗 Full Integration - Seamless GitHub, Git, Jira, and security tool integration
• ⚡ Zero Context Switching - Everything happens within your IDE

✨ Key Features

Feature	Description
Smart PR Creation	Automatically generates PR descriptions, links Jira tickets, and validates changes
Comprehensive Reviews	AI-powered code review with bug detection, security scanning, and compliance checks
Safe Updates	Intelligent PR modifications that preserve important information
CVE Scanning	Real-time vulnerability detection in dependencies and code
Jira Integration	Automatic ticket linking, requirement verification, and status updates
GitHub Actions	Workflow management, CI/CD integration, and automated testing

📁 Repository Structure

pr-buddy/
├── README.md                    # You are here!
├── setup_pr_buddy.sh           # One-click installation script
├── docs/                       # Detailed documentation
│   ├── PREREQUISITES.md        # System requirements & tools
│   ├── SETUP_GITHUB.md        # GitHub token setup guide
│   ├── SETUP_JIRA.md          # Jira integration guide
│   └── TROUBLESHOOTING.md     # Common issues & solutions
├── rules/                      # AI agent rules for Cursor
│   ├── pr-creation.mdc        # PR creation assistant
│   ├── pr-review.mdc          # PR review assistant
│   └── pr-update.mdc          # PR update assistant
└── servers/                    # MCP servers (git submodules)
    ├── cve-search/            # CVE vulnerability scanner
    ├── git/                   # Git operations server
    ├── github-mcp-server/     # GitHub integration
    └── jira-mcp/             # Jira integration

🚀 Quick Start

Prerequisites

Before starting, ensure you have:

• ✅ Python 3.10+
• ✅ Git
• ✅ Cursor IDE (latest version)
• ✅ Go 1.21+ or Docker (for GitHub server)

👉 Detailed Prerequisites Guide

Installation

# 1. Clone the repository with submodules
git clone --recursive https://github.com/YOUR_USERNAME/pr-buddy.git
cd pr-buddy

# 2. Run the interactive setup script
./setup_pr_buddy.sh

# 3. Copy the generated configuration to Cursor
cp ~/.pr-buddy/mcp.json ~/.cursor/mcp.json

# 4. Restart Cursor and enable Agent Mode

The setup script will:

• ✅ Check all system requirements
• ✅ Install missing dependencies
• ✅ Configure all MCP servers
• ✅ Set up authentication tokens
• ✅ Install AI rules globally
• ✅ Test your connections

📖 Documentation

Setup Guides

Guide	Description
📋 Prerequisites	System requirements, tool installation, and environment setup
🔐 GitHub Setup	Creating and configuring GitHub Personal Access Tokens
🎫 Jira Setup	Setting up Jira API tokens and integration
🔧 Troubleshooting	Solutions for common issues and debugging tips

Quick References

Document	Description
📜 Quick Reference	Command cheat sheet and shortcuts
🏗️ Architecture	Detailed system design and diagrams
📝 ASCII Diagrams	Architecture diagrams in ASCII format
🤝 Contributing	How to contribute to PR Buddy

💡 Usage Examples

Creating a Pull Request

@pr-creation.mdc Create a PR for the authentication feature on master branch.
The changes are in feature/auth-oauth branch. This addresses Jira ticket DSE-1234.

Reviewing a Pull Request

@pr-review.mdc Review PR Sense/cloudera-sense/789 thoroughly.
Check for security vulnerabilities, bugs, and Jira compliance.

Updating a Pull Request

@pr-update.mdc Update PR Sense/cloudera-sense/456 description
with the latest Jira requirements while preserving test evidence.

Quick Commands

Command	Description
@pr-creation.mdc	Activate PR creation assistant
@pr-review.mdc	Activate PR review assistant
@pr-update.mdc	Activate PR update assistant

🎮 How PR Buddy Works

graph LR
    A[Developer] --> B[Cursor IDE]
    B --> C{PR Buddy Rules}
    C --> D[Git Server]
    C --> E[GitHub Server]
    C --> F[Jira Server]
    C --> G[CVE Scanner]

    D --> H[Local Operations]
    E --> I[PR Management]
    F --> J[Ticket Sync]
    G --> K[Security Scan]

    style C fill:#4CAF50,stroke:#2E7D32,color:#fff
    style B fill:#2196F3,stroke:#1565C0,color:#fff

Loading

🔧 Advanced Configuration

Customizing for Your Workflow

1. Global Rules (for all projects):

   cp rules/*.mdc ~/.cursor/rules/

2. Project-Specific Rules:

   mkdir -p .cursor/rules
   cp /path/to/pr-buddy/rules/*.mdc .cursor/rules/

3. Custom Toolsets (optimize performance):

{
  "env": {
    "GITHUB_TOOLSETS": "repos,pull_requests,issues"
  }
}

Security Best Practices

• 🔐 Use environment variables for tokens
• 🔄 Rotate tokens every 90 days
• 🛡️ Use fine-grained GitHub tokens
• 📝 Enable audit logging

🐛 Getting Help

Quick Fixes

• MCP servers not starting? → Check Troubleshooting Guide
• Authentication failing? → Review GitHub Setup or Jira Setup
• Rules not working? → See Troubleshooting Guide

Support Channels

• 📝 GitHub Issues - Bug reports and feature requests
• 💬 Discussions - Questions and community help
• 📧 Email: support@pr-buddy.dev

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for:

• Code of conduct
• Development setup
• Submission guidelines
• Coding standards

📄 License

PR Buddy is licensed under the MIT License. See LICENSE for details.

🙏 Acknowledgments

• Model Context Protocol team for the MCP framework
• Cursor team for the amazing IDE integration
• GitHub, Atlassian, and CIRCL for their APIs
• All contributors and users of PR Buddy

---

Built with ❤️ for developers who value quality and efficiency
PR Buddy - Your AI-powered pull request companion