Using the GitHub MCP Server

GitHub MCP サーバーについて

GitHub MCP サーバーとは、GitHub によって提供および管理されるモデル コンテキスト プロトコル (MCP) サーバーです。 MCP を使うと、AI 機能を他のツールやサービスと統合し、コンテキスト対応の AI 支援を提供することで開発エクスペリエンスを強化できます。

MCP の詳細については、MCP 公式ドキュメントを参照してください。

GitHub MCP サーバーは、Visual Studio Code やリモート MCP をサポートする他のエディターを介してリモートでアクセスすることも、MCP と互換性のある任意のエディターを使ってローカル環境で実行することもでき、ホストされたソリューションの便利さと、セルフホステッド セットアップのカスタマイズしやすさのいずれかを選択できます。

リモートの GitHub MCP サーバーを利用する場合は、ローカル環境を設定することなく、数ステップで行うことができます。 これは、ローカル MCP サーバーを管理するオーバーヘッドなしに、GitHub の AI 機能をすぐにでも活用したいユーザーに特に便利です。

GitHub MCP サーバーをローカル環境で実行すると、さらに多くのセットアップが必要ですが、AI の対話をカスタマイズして制御できる範囲が広がります。

GitHub MCP サーバーを使うと次のことができます。

• コード関連のタスクを自動化および効率化します。
• サードパーティのツール (Cursor、Windsurf、将来の統合など) を接続して、GitHub のコンテキストと AI の機能を活用します。
• ローカル環境を設定しないで、任意のデバイスから動作するクラウドベースのワークフローを有効にします。

可用性

現在、Visual Studio Code、JetBrains IDE、XCode、その他のクライアントで、ローカル MCP サーバーが幅広くサポートされています。

リモート MCP サーバーのサポートは増えており、Visual Studio Code (OAuth または PAT を使用)、Visual Studio (PAT のみ)、Windsurf (PAT のみ)、Cursor (PAT のみ) などのエディターでこの機能が既に提供されています。

好みのエディターでリモート MCP サーバーがサポートされているかどうかを調べるには、特定のエディターのドキュメントを確認してください。

前提条件

• GitHub アカウント。
• Visual Studio Code または別の MCP 互換エディター。

Prerequisites

• A GitHub account.
• Visual Studio Code, or another MCP-compatible editor.

Setting up the GitHub MCP server in Visual Studio Code

The instructions below guide you through setting up the GitHub MCP server in Visual Studio Code. Other MCP-compatible editors may have similar steps, but the exact process may vary.

You can choose to set up the GitHub MCP server either remotely or locally, depending on your needs and preferences. You can also configure your GitHub MCP server for either:

• 特定のリポジトリ。 これにより、Visual Studio Code でプロジェクトを開いたすべてのユーザーと MCP サーバーを共有できます。 これを行うには、リポジトリのルートに .vscode/mcp.json ファイルを作成します。
• Visual Studio Code の個人インスタンス。 構成した MCP サーバーにアクセスできるのは自分だけです。 これを行うには、Visual Studio Code で settings.json ファイルに構成を追加します。 この方法で構成された MCP サーバーは、すべてのワークスペースで使用できます。

The remote GitHub MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a personal access token (PAT) for authentication. If you use OAuth, the MCP server will have the same access as your personal account. If you use a PAT, the MCP server will have access to the scopes granted by the PAT.

• Remote MCP server configuration with OAuth
• Remote MCP server configuration with PAT
• Local MCP server setup

Remote MCP server configuration with OAuth

You do not need to create a PAT or install any additional software to use the remote GitHub MCP server with OAuth. You can set it up directly in Visual Studio Code. You can also install individual toolsets, either in read-only mode or with full read/write access, allowing you to tailor the server's capabilities to your specific needs. For more information, see Tool configuration.

1. In Visual Studio Code, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).

2. Type: mcp: add server and then press Enter.

3. From the list, select HTTP (HTTP or Server-Sent Events).

4. In the Server URL field, enter https://api.githubcopilot.com/mcp/, and press Enter.

5. Under Enter Server ID, press Enter to use the default server ID, or enter a custom server ID.

6. Under Choose where to save the configuration, select where you want to save the MCP server configuration.

   • Visual Studio Code will open and add the configuration to the selected file in the editor, or create a new file if it doesn't exist.

7. In the Visual Studio Code popup, to authorize the MCP server with OAuth, click Allow and select your personal account from the list.

Remote MCP server configuration with PAT

To configure the remote GitHub MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see 個人用アクセス トークンを管理する.

You will need to manually configure the MCP server in Visual Studio Code to use the PAT for authorization.

1. In Visual Studio Code, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).

2. Type: mcp: add server and then press Enter.

3. From the list, select HTTP (HTTP or Server-Sent Events).

4. In the Server URL field, enter https://api.githubcopilot.com/mcp/, and press Enter.

5. Under Enter Server ID, press Enter to use the default server ID, or enter a custom server ID.

6. Under Choose where to save the configuration, select where you want to save the MCP server configuration.

   • Visual Studio Code will open and add the configuration to the selected file in the editor, or create a new file if it doesn't exist.

7. In the Visual Studio Code popup, to decline OAuth authorization, click Cancel.

8. You will need to manually edit the configuration file to use a PAT. In the configuration file, at the end of the url line, add the following:

   JSON

       ,
         "headers": {
           "Authorization": "Bearer ${input:github_token}"
         }
       },
     },
     "inputs": [
       {
         "id": "github_token",
         "type": "promptString",
         "description": "GitHub Personal Access Token",
         "password": true
       }
     ]
   }
   

9. A "Restart" button will appear in the file. Click "Restart" to restart the MCP server with the new configuration.

   

10. In the command palette, you will see a prompt to enter your GitHub token. Enter the PAT you created earlier, and press Enter.

    • The MCP server will now be configured to use the PAT for authorization.

Local MCP server setup

Using the GitHub MCP server locally requires you to have Docker installed and running on your machine. Additionally, you can only authenticate with a PAT, as OAuth is not supported for local MCP servers.

1. Ensure you have Docker installed and running on your machine. See Docker installation instructions.

2. Create a PAT with (at least) the read:packages and repo scopes. For more information, see 個人用アクセス トークンを管理する.

3. Decide whether you want to configure the MCP server for a specific repository or for your personal instance of Visual Studio Code.

   • If you are using a specific repository, open the .vscode/mcp.json file in Visual Studio Code, and add the following configuration:
   JSON

      {
       "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}"
           }
         }
       }
     }
   

   • If you are using your personal instance of Visual Studio Code, open your settings.json file in Visual Studio Code:
     • Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
     • Type Preferences: Open Settings (JSON) and select it.
     • Add the following configuration:
   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}"
           }
         }
       }
     }
   }
   

4. Save the file.

5. In the command palette, you will see a prompt to enter your GitHub token. Enter the PAT you created earlier, and press Enter.

   • The MCP server will now be configured to run locally with the PAT for authorization.

Tool configuration

The GitHub MCP server supports installing individual toolsets, either in read-only mode or with full read/write access, allowing you to tailor the server's capabilities to your specific needs. For one-click installation options of each toolset, see the GitHub MCP server repository.

Using the GitHub MCP server in Visual Studio Code

The GitHub MCP server enables you to perform a wide range of actions on GitHub, via Copilot Chat in Visual Studio Code.

1. Visual Studio Code のタイトル バーの アイコンをクリックして、Copilot Chat を開きます。
2. Copilot Chat ボックスで、ポップアップ メニューから [Agent] を選びます。
3. To see the available actions, in the Copilot Chat box, click the Select tools icon.
   • In the Tools dropdown, under MCP Server: GitHub, you will see a list of available actions.
4. In the Copilot Chat box, type a command or question related to the action you want to perform, and press Enter.
   • For example, you can ask the GitHub MCP server to create a new issue, list pull requests, or retrieve repository information.
5. The GitHub MCP server will process your request and provide a response in the chat interface.
   • In the Copilot Chat box, you may be asked to give additional permissions or provide more information to complete the action.
6. Follow the prompts to complete the action.

  {
    "servers": {
        "github": {
            "url": "https://api.githubcopilot.com/mcp/",
            "requestInit": {
                "headers": {
                    "Authorization": "Bearer YOUR_GITHUB_PAT"
                }
            }
        }
    }
  }

  {
    "servers": {
        "github": {
            "url": "https://api.githubcopilot.com/mcp/",
            "requestInit": {
                "headers": {
                    "Authorization": "Bearer YOUR_GITHUB_PAT"
                }
            }
        }
    }
  }

  {
    "servers": {
        "github": {
            "url": "https://api.githubcopilot.com/mcp/",
            "requestInit": {
                "headers": {
                    "Authorization": "Bearer YOUR_GITHUB_PAT"
                }
            }
        }
    }
  }

  {
    "servers": {
        "github": {
            "url": "https://api.githubcopilot.com/mcp/",
            "requestInit": {
                "headers": {
                    "Authorization": "Bearer YOUR_GITHUB_PAT"
                }
            }
        }
    }
  }

  {
    "servers": {
        "github": {
            "url": "https://api.githubcopilot.com/mcp/",
            "requestInit": {
                "headers": {
                    "Authorization": "Bearer YOUR_GITHUB_PAT"
                }
            }
        }
    }
  }

  {
    "servers": {
        "github": {
            "url": "https://api.githubcopilot.com/mcp/",
            "requestInit": {
                "headers": {
                    "Authorization": "Bearer YOUR_GITHUB_PAT"
                }
            }
        }
    }
  }