Github Pr MCP Server

🚀 GitHub PR Management Server

The GitHub PR Management Server is a powerful tool designed to streamline the process of creating and managing Pull Requests on GitHub. It offers both basic and enhanced features, making it easier for developers to collaborate and maintain their projects.

🚀 Quick Start

Prerequisites

• Node.js 18+
• npm or yarn
• Git
• A GitHub account and a personal access token

Global Installation

npm install -g github-pr-mcp

Start the Server

github-pr-mcp start

📦 Installation

Prerequisites

• Node.js 18+
• npm or yarn
• Git
• A GitHub account and a personal access token

Global Installation

npm install -g github-pr-mcp

Start the Server

github-pr-mcp start

💻 Usage Examples

Configuration File Example

// config.json
{
  "servers": [
    {
      "name": "github",
      "type": "github",
      "token": "your_github_token"
    },
    {
      "name": "github-pr",
      "type": "github-pr",
      "token": "your_github_token",
      "enhancedFeatures": true
    }
  ]
}

Start the Server (Specify Configuration File)

github-pr-mcp start --config config.json

✨ Features

Core Features

1. Create Pull Request
   • Offers basic and enhanced features, including code highlights, test reports, etc.
2. Manage Pull Request
   • List, update, and close Pull Requests.

Available Tools

create_pull_request

Create a Pull Request with enhanced features:

{
  // Required fields (compatible with basic features)
  owner: string;        // Owner
  repo: string;         // Repository name
  title: string;        // Title
  head: string;         // Branch name (e.g., feature-branch)
  base: string;         // Base branch (e.g., main)

  // Optional fields (compatible with basic features)
  body?: string;        // Description
  draft?: boolean;      // Whether it's a draft
  maintainer_can_modify?: boolean; // Whether maintainers can modify

  // Enhanced feature fields
  overview?: string;    // Overview
  keyChanges?: string[];// Key changes
  codeHighlights?: string[];// Code highlights
  testing?: string[];// Test reports
  links?: Array<{ title: string; url: string }>; // Link list
  additionalNotes?: string; // Additional notes
  issueIds?: string[];// Associated Issue IDs
  checklist?: {
    adhereToConventions?: boolean; // Whether it adheres to conventions
    testsIncluded?: boolean;        // Whether tests are included
    documentationUpdated?: boolean;  // Whether documentation is updated
    changesVerified?: boolean;       // Whether changes are verified
    screenshotsAttached?: boolean;   // Whether screenshots are attached
  };
  attachments?: Array<{
    type: "image" | "video" | "diagram"; // Type
    alt: string;                         // Alt text
    url: string;                          // Link
    width?: number;                      // Width (optional)
  }>;
  labels?: string[];// Labels
  reviewers?: string[];// Reviewers
  assignees?: string[];// Assignees
}

list_pull_requests

List Pull Requests in a repository:

{
  owner: string; // Owner
  repo: string;  // Repository name
}

update_pull_request

Update a Pull Request:

{
  owner: string;         // Owner
  repo: string;          // Repository name
  pullRequestId: number; // Pull Request ID
  title?: string;        // New title (optional)
  body?: string;         // New description (optional)
  labels?: string[];// New labels (optional)
}

📚 Documentation

Development Guide

Clone the Project

git clone https://github.com/yourusername/github-pr-mcp.git
cd github-pr-mcp

Install Dependencies

npm install

Start the Development Server

npm run dev

Build the Project

npm run build

Testing Guide

Unit Tests

npm test

Integration Tests

npm run integration-test

Troubleshooting

Common Issues

1. Server fails to start
   • Check if the configuration file is correct.
   • Ensure that the token has the correct permissions.
2. Unable to create a Pull Request
   • Verify the repository access permissions.
   • Check if the branch and base branch exist.

Contribution Guide

Submit Code

1. Create a feature branch: git checkout -b feature/your-feature
2. Commit your changes: git commit -m "feat: Add new feature"
3. Push to the remote repository: git push origin feature/your-feature

Submit a Pull Request

• Submit a Pull Request on the GitHub repository.
• Include a detailed description of the changes.

Project Structure

github-pr-mcp/
├── src/                 # Source code directory
│   ├── server.js        # Main server file
│   └── config.js       # Configuration management
├── package.json         # Dependency management
└── README.md            # Project documentation

📄 License

MIT License

📞 Contact

• GitHub Issues
• Email: contact@github-pr-mcp.com