GitHub

The GitHub MCP Server connects GitHub APIs to your tools via the Model Context Protocol, enabling automated workflows, data extraction, and AI-powered interactions with GitHub. It runs as an MCP server that you deploy locally or in your environment, and you interact with it through an MCP client to perform tasks like managing issues, pull requests, repositories, and more without leaving your workflow.

How to use

You use an MCP client to connect to the GitHub MCP Server. Start the server in your environment (typically via Docker) and then configure your MCP client to target the server. Once connected, you can perform operations such as getting user data, creating issues, commenting on pull requests, and managing repositories. The server exposes a wide range of tools that you can call through your client to automate GitHub tasks inside your applications, scripts, or AI assistants.

How to install

json
{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "github_token",
        "description": "GitHub Personal Access Token",
        "password": true
      }
    ],
    "servers": {
      "github": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "GITHUB_PERSONAL_ACCESS_TOKEN",
          "ghcr.io/github/github-mcp-server"
        ],
        "env": {
          "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
        }
      }
    }
  }
}

json
{
  "mcpServers": {
    "github": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "GITHUB_PERSONAL_ACCESS_TOKEN",
        "ghcr.io/github/github-mcp-server"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

Additional configuration and build notes

Prerequisites include Docker to run the MCP server in a container. You also need a GitHub Personal Access Token with the permissions you want your AI tools to access. You can generate this token in your GitHub account settings and assign the necessary scopes for the tasks you intend to automate.

Available tools

get_me

Get details of the authenticated user

get_issue

Get the contents of an issue within a repository

get_issue_comments

Get comments for a GitHub issue

create_issue

Create a new issue in a GitHub repository

add_issue_comment

Add a comment to an issue

list_issues

List and filter repository issues

update_issue

Update an existing issue in a GitHub repository

search_issues

Search for issues and pull requests

get_pull_request

Get details of a specific pull request

list_pull_requests

List and filter repository pull requests

merge_pull_request

Merge a pull request

get_pull_request_files

Get the list of files changed in a pull request

get_pull_request_status

Get the combined status of all status checks for a pull request

update_pull_request_branch

Update a pull request branch with the latest changes from the base branch

get_pull_request_comments

Get the review comments on a pull request

get_pull_request_reviews

Get the reviews on a pull request

create_pull_request_review

Create a review on a pull request

create_pull_request

Create a new pull request

create_or_update_file

Create or update a single file in a repository

push_files

Push multiple files in a single commit

search_repositories

Search for GitHub repositories

create_repository

Create a new GitHub repository

get_file_contents

Get contents of a file or directory

fork_repository

Fork a repository

create_branch

Create a new branch

list_commits

Gets commits of a branch in a repository

search_code

Search for code across GitHub repositories

search_users

Search for GitHub users

get_code_scanning_alert

Get a code scanning alert

list_code_scanning_alerts

List code scanning alerts for a repository