Github Pr MCP

🚀 GitHub PR Comment MCP Server

This is a Model Context Protocol (MCP) server that uses a GitHub personal access token to fetch GitHub pull request comments. It offers a convenient way to access and manage PR comments in a structured format.

🚀 Quick Start

This MCP server simplifies the process of retrieving GitHub PR comments. Follow the steps below to get started:

Installation

There are two ways to install the github-pr-mcp server:

Automatic Installation via Smithery

To automatically install github-pr-mcp for Claude Desktop using Smithery, run the following command:

npx -y @smithery/cli install github-pr-mcp --client claude

Manual Installation

1. Clone the repository.
2. Install the dependencies:

   npm install
   

3. Create a .env file containing your GitHub token:

   GITHUB_TOKEN=your_github_token_here
   

Usage

1. Build the project:

   npm run build
   

2. Start the server: You can either start the server using the configured token or provide it directly:

   npm start
   

   Or

   node dist/server.js your_github_token_here
   

3. The server provides a tool named get_pr_comments that accepts the following parameters:
   • owner: The owner of the repository (username or organization).
   • repo: The name of the repository.
   • pull_number: The number of the pull request.

✨ Features

• Comprehensive Comment Retrieval: Fetch PR comments with file paths, line ranges, and replies.
• GitHub API Integration: Utilize Octokit to call the GitHub API efficiently.
• MCP Server Implementation: Built with StdioServerTransport for seamless MCP support.
• Structured Output: Return comments in a structured JSON format for easy consumption.

💻 Usage Examples

Basic Usage

Here's how you can use the server to get PR comments:

# Build the project
npm run build
# Start the server
npm start

Advanced Usage

If you want to run the server directly with a GitHub token:

node dist/server.js your_github_token_here

📦 Installation

Automatic Installation via Smithery

npx -y @smithery/cli install github-pr-mcp --client claude

Manual Installation

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Create a .env file with your GitHub token:

   GITHUB_TOKEN=your_github_token_here
   

📚 Documentation

Integration with Cursor

To integrate this server with Cursor, use the following command in Cursor's MCP server configuration:

node /path/to/dist/server.js your_github_token_here

Replace /path/to with the actual project path and your_github_token_here with your GitHub personal access token.

Testing

The project includes a test client to verify the server's functionality:

1. Build the project:

   npm run build
   

2. Run the test client:

   npm test
   

The test client will start the server, connect to it, and call the get_pr_comments tool with sample parameters.

Response Format

The server returns comments in the following JSON format:

{
  "comments": [
    {
      "id": 123456789,
      "path": "src/example.js",
      "body": "This is a comment on a specific line",
      "line": 42,
      "start_line": 40,
      "user": {
        "login": "username"
      },
      "created_at": "2023-01-01T00:00:00Z",
      "replies": [
        {
          "id": 987654321,
          "body": "This is a reply to the comment",
          "user": {
            "login": "another-username"
          },
          "created_at": "2023-01-02T00:00:00Z"
        }
      ]
    }
  ]
}

📄 License

This project is licensed under the ISC license.