Utilisation du serveur MCP GitHub

À propos du serveur MCP GitHub

Le serveur MCP GitHub est un serveur MCP (Model Context Protocol) fourni et géré par GitHub. Le protocole MCP vous permet d’intégrer des capacités d’IA à d’autres outils et services, améliorant ainsi votre expérience de développement grâce à une assistance IA contextuelle.

Pour une présentation complète du serveur MCP GitHub et une vue d’ensemble de MCP, consultez À propos du protocole MCP (Model Context Protocol).

Prérequis

• Un compte GitHub.
• Visual Studio Code, ou un autre éditeur compatible avec le protocole MCP.
• Si vous êtes membre d’une organisation ou d’une entreprise avec un plan Copilot Business ou Copilot Enterprise, la stratégie « Serveurs MCP dans Copilot » doit être activée pour pouvoir utiliser MCP avec Copilot.

Configuration du serveur MCP GitHub dans Visual Studio Code

Les instructions ci-dessous vous guident dans la configuration du serveur MCP GitHub dans Visual Studio Code. D’autres éditeurs compatibles avec le protocole MCP peuvent suivre des étapes similaires, mais le processus exact peut varier.

Vous pouvez choisir de configurer le serveur MCP GitHub à distance ou localement, selon vos besoins et vos préférences. Vous pouvez également configurer votre serveur MCP GitHub pour :

• Un référentiel spécifique. Cela vous permet de partager les serveurs MCP avec toute personne qui ouvre le projet dans Visual Studio Code. Pour ce faire, créez un fichier à la racine de votre référentiel .vscode/mcp.json.
• Votre instance personnelle de Visual Studio Code. Vous serez la seule personne ayant accès aux serveurs MCP configurés. Pour ce faire, ajoutez la configuration à votre fichier settings.json dans Visual Studio Code. Les serveurs MCP configurés de cette manière seront disponibles dans tous les espaces de travail.

Le serveur MCP GitHub distant utilise par défaut l’authentification OAuth en un clic, mais vous pouvez également le configurer manuellement pour utiliser un personal access token (PAT) pour l’authentification. Si vous utilisez OAuth, le serveur MCP ne peut accéder qu’aux étendues que vous approuvez lors de la connexion. Dans les contextes appartenant à l’organisation, l’accès peut également être limité par des politiques d’administration qui contrôlent les étendues et les applications autorisées. Si vous utilisez un PAT, le serveur MCP aura accès aux étendues accordées par le PAT, qui est également soumis à toutes les restrictions PAT configurées par l’organisation.

Si vous êtes un Enterprise Managed User, le PAT est désactivé par défaut, sauf s’il est activé par un administrateur d’entreprise. Si le PAT est désactivé, vous ne pourrez pas utiliser l’authentification PAT. Si vous avez des restrictions liées à la politique d’accès OAuth, vous devrez activer l’application OAuth pour chaque client (application hôte MCP), à l’exception de Visual Studio Code et Visual Studio, qui sont des IDE Microsoft propriétaires intégrant nativement Copilot.

• Configuration du serveur MCP distant avec OAuth
• Configuration du serveur MCP distant avec PAT
• Configuration du serveur MCP local

Configuration du serveur MCP distant avec OAuth

Vous n’avez pas besoin de créer un PAT ni d’installer un logiciel supplémentaire pour utiliser le serveur MCP GitHub distant avec OAuth. Vous pouvez le configurer directement dans Visual Studio Code. Vous pouvez également installer des ensembles d’outils individuels, en mode lecture seule ou avec un accès complet en lecture/écriture, ce qui vous permet d’adapter les capacités du serveur à vos besoins spécifiques. Pour plus d’informations, consultez Configuration des outils.

1. Dans Visual Studio Code, ouvrez la palette de commandes en appuyant sur Ctrl+Maj+P (Windows/Linux) / Commande+Maj+P (Mac).

2. Tapez : mcp: add server, puis appuyez sur Entrée.

3. Dans la liste, sélectionnez HTTP (HTTP ou événements envoyés par le serveur).

4. Dans le champ URL du serveur, entrez https://api.githubcopilot.com/mcp/, puis appuyez sur Entrée.

5. Sous Entrer l’ID du serveur, appuyez sur Entrée pour utiliser l’ID du serveur par défaut, ou entrez un ID de serveur personnalisé.

6. Sous Choisissez où enregistrer la configuration, sélectionnez l’emplacement où vous souhaitez enregistrer la configuration du serveur MCP.

   • Visual Studio Code ouvrira et ajoutera la configuration au fichier sélectionné dans l’éditeur, ou créera un nouveau fichier s’il n’existe pas.

7. Dans la fenêtre contextuelle Visual Studio Code, pour autoriser le serveur MCP avec OAuth, cliquez sur Autoriser et sélectionnez votre compte personnel dans la liste.

Configuration du serveur MCP distant avec PAT

Pour configurer le serveur MCP GitHub distant avec un PAT, vérifiez que vous avez créé un PAT avec les étendues nécessaires pour l’accès que vous souhaitez accorder au serveur MCP. Pour plus d’informations, consultez « Gestion de vos jetons d'accès personnels ».

Vous devrez configurer manuellement le serveur MCP dans Visual Studio Code pour utiliser le PAT pour l’autorisation.

1. Dans Visual Studio Code, ouvrez la palette de commandes en appuyant sur Ctrl+Maj+P (Windows/Linux) / Commande+Maj+P (Mac).

2. Tapez : mcp: add server, puis appuyez sur Entrée.

3. Dans la liste, sélectionnez HTTP (HTTP ou événements envoyés par le serveur).

4. Dans le champ URL du serveur, entrez https://api.githubcopilot.com/mcp/, puis appuyez sur Entrée.

5. Sous Entrer l’ID du serveur, appuyez sur Entrée pour utiliser l’ID du serveur par défaut, ou entrez un ID de serveur personnalisé.

6. Sous Choisissez où enregistrer la configuration, sélectionnez l’emplacement où vous souhaitez enregistrer la configuration du serveur MCP.

   • Visual Studio Code ouvrira et ajoutera la configuration au fichier sélectionné dans l’éditeur, ou créera un nouveau fichier s’il n’existe pas.

7. Dans la fenêtre contextuelle Visual Studio Code, pour refuser l’autorisation OAuth, cliquez sur Annuler.

8. Vous devrez modifier manuellement le fichier de configuration pour utiliser un PAT. Dans le fichier config, ajoutez à la fin de la ligne url ce qui suit :

   JSON

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

9. Un bouton « Redémarrer » apparaîtra dans le fichier. Cliquez sur « Redémarrer » pour redémarrer le serveur MCP avec la nouvelle configuration.

   

10. Dans la palette de commandes, un prompt vous demandera d’entrer votre jeton GitHub. Entrez le PAT que vous avez créé précédemment, puis appuyez sur Entrée.

    • Le serveur MCP sera alors configuré pour utiliser le PAT pour l’autorisation.

Configuration du serveur MCP local

Pour utiliser le protocole MCP GitHub localement, vous devez avoir installé et exécuté Docker sur votre machine. De plus, vous pouvez uniquement vous authentifier avec un PAT, car OAuth n’est pas pris en charge pour les serveurs MCP locaux.

1. Vérifiez que Docker est installé et fonctionne correctement sur votre ordinateur. Consultez Instructions d’installation de Docker.

2. Créez un PAT avec (au moins) les étendues read:packages et repo. Pour plus d’informations, consultez « Gestion de vos jetons d'accès personnels ».

3. Décidez si vous souhaitez configurer le serveur MCP pour un référentiel spécifique ou pour votre instance personnelle de Visual Studio Code.

   • Si vous utilisez un référentiel spécifique, ouvrez le fichier .vscode/mcp.json dans Visual Studio Code et ajoutez la configuration suivante :
   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}"
           }
         }
       }
     }
   

   • Si vous utilisez votre instance personnelle de Visual Studio Code, ouvrez votre fichier settings.json dans Visual Studio Code :
     • Appuyez sur Ctrl+Maj+P (Windows/Linux) ou Cmd+Maj+P (macOS).
     • Tapez Préférences : ouvrir les paramètres (JSON) et sélectionnez cette option.
     • Ajouter la configuration suivante :
   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. Enregistrez le fichier.

5. Dans la palette de commandes, vous verrez un prompt vous demandant d’entrer votre jeton GitHub. Entrez le PAT que vous avez créé précédemment, puis appuyez sur Entrée.

   • Le serveur MCP sera alors configuré pour fonctionner localement avec le PAT pour l’autorisation.

Configuration de l’outil

Le serveur MCP GitHub prend en charge l’installation d’ensembles d’outils individuels, en mode lecture seule ou avec un accès complet en lecture/écriture, ce qui vous permet d’adapter les capacités du serveur à vos besoins spécifiques. Pour les options d’installation en un clic de chaque ensemble d’outils, consultez le référentiel du serveur MCP GitHub.

Utilisation du serveur MCP GitHub dans Visual Studio Code

Le serveur MCP GitHub vous permet d’effectuer toute une série d’actions sur GitHub, via Copilot Chat dans Visual Studio Code.

1. Ouvrez Copilot Chat en cliquant sur l’icône dans la barre de titre de Visual Studio Code.
2. Dans la zone Copilot Chat, sélectionnez Agent dans le menu déroulant.
3. Pour afficher les actions disponibles, dans la zone Copilot Chat, cliquez sur l’icône Sélectionner les outils.
   • Dans le menu déroulant Outils, sous Serveur MCP :GitHub, vous verrez une liste des actions disponibles.
4. Dans la zone Copilot Chat, tapez une commande ou une question relative à l’action que vous souhaitez effectuer, puis appuyez sur Entrée.
   • Par exemple, vous pouvez demander au serveur MCP GitHub de créer un nouveau problème, de répertorier les demandes de tirage ou de récupérer des informations sur le référentiel.
5. Le serveur MCP GitHub traitera votre demande et fournira une réponse dans l’interface de conversation.
   • Dans la zone Copilot Chat, il peut vous être demandé d'accorder des autorisations supplémentaires ou de fournir plus d’informations pour terminer l’action.
6. Suivez les prompts pour terminer l’action.

Dépannage

Si vous rencontrez des problèmes lors de l’utilisation du serveur MCP GitHub, vous pouvez suivre quelques étapes courantes de résolution des problèmes.

Problèmes d’autorisation

Si vous rencontrez des problèmes pour autoriser le serveur MCP, vérifiez que :

• Vous êtes connecté à GitHub dans l’IDE de votre choix.

Si vous vous authentifiez avec un personal access token (PAT), vérifiez que :

• Votre PAT GitHub est valide et dispose des étendues nécessaires pour les actions que vous souhaitez effectuer.
• Vous avez entré le jeton d'accès personnel approprié.

Problèmes liés au mode agent de Copilot

Si vous rencontrez des problèmes avec le mode agent de Copilot Chat, vérifiez que :

• Vous avez sélectionné l’agent correct dans la zone Copilot Chat.
• Vous avez configuré le serveur MCP correctement dans votre IDE.
• Vous disposez des autorisations nécessaires pour effectuer les actions que vous essayez d’exécuter.

Blocage de la protection d’envoi (push)

Si vous utilisez le serveur MCP GitHub et que la protection d’envoi (push) bloque un secret que vous considérez sûr à exposer, vous pouvez contourner le blocage en spécifiant une raison pour autoriser le secret. Consultez Utilisation de la protection d’envoi (push) et du serveur MCP GitHub.

Conseils généraux

Si vous rencontrez d’autres problèmes avec le serveur MCP GitHub, voici quelques conseils généraux pour vous aider à les résoudre :

• Vérifiez les journaux de sortie du serveur MCP pour vérifier la présence de messages d’erreur.
• Si vous exécutez le serveur MCP localement, vérifiez que votre environnement local est correctement configuré pour exécuter des conteneurs Docker.
• Essayez de redémarrer le serveur MCP ou votre IDE.

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