Github PR Helper

🚀 GitHub Pull Request Helper Tool

This tool simplifies the process of creating and managing GitHub Pull Requests (PRs) in an AI editor. It offers the following benefits:

• Streamlined Workflow: Automates authentication using GitHub CLI (gh), eliminating the need for manual token management.
• Modular Operations: Provides two core functions:
  • create_pull_request: Initiate a new pull request.
  • add_pr_comment: Add comments to an existing pull request.

🚀 Quick Start

📦 Installation

1. Install GitHub CLI

Before using this tool, install and configure GitHub CLI:

brew install gh  # Install on Mac
# Or download the installer for your OS from https://github.com/cli/.

2. Log in to GitHub CLI

Log in to your GitHub account using the following command:

gh auth login

Follow the prompts to complete the login process.

3. Configure the AI Editor

Add the MCP service to your editor's settings based on your editor (e.g., Cursor, Windsurf). Here's how to configure it in Cursor:

1. Open the editor's settings.
2. Navigate to Experimental Features > MCP Service Settings.
3. Add a new MCP service with the following details:

• Name: github-pr-helper
• Type: Command
• Command: /Users/yourusername/CascadeProjects/app-github-pr-helper/src/mcp-server.js

Save the settings and restart the editor.

💻 Usage Examples

Basic Usage

Create a New Pull Request

Use the following prompt in the AI editor:

Please use the create_pull_request tool to create a GitHub pull request.
Parameters:
{
  "repoPath": "/path/to/your/repo",
  "title": "Your PR Title",
  "description": "Describe the main changes in this PR.",
  "ticketNumber": "e.g., JIRA-123",
  "baseBranch": "Base branch name, e.g., main"
}

Add a Comment to a Pull Request

Use the following prompt in the AI editor:

Please use the add_pr_comment tool to add a comment to a PR.
Parameters:
{
  "repoPath": "/path/to/your/repo",
  "baseBranch": "Base branch name, e.g., main",
  "filePath": "Path to the file to comment on, e.g., src/index.js",
  "lineNumber": Line number to comment on,
  "comment": "Your comment"
}

⚠️ Important Note

• Before using this tool, ensure you've logged in to your GitHub account using gh auth login.
• Create and switch to the branch for your PR in your local repository.
• Commit and push all changes to the remote repository.
• This tool uses GitHub CLI for GitHub-related operations, eliminating the need for manual token management.
• If you encounter issues, check your GitHub CLI login status using:

gh auth status

We hope this tool enhances your GitHub workflow!