> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Utiliser des agents de codage IA avec le GDK

> Fournissez aux agents de codage IA un contexte exact du Microsoft Game Development Kit (GDK), adapté à votre version : le serveur MCP de la documentation, la documentation Markdown hors ligne, les en-têtes installés, les outils en ligne de commande et un fichier d'instructions de projet.

Les agents de codage IA, comme GitHub Copilot, Claude Code, Codex et Cursor, écrivent un meilleur code GDK lorsqu'ils s'appuient sur les API et la documentation du GDK avec lequel vous compilez, plutôt que sur ce dont leur modèle se souvient. Cet article décrit le contexte GDK que vous pouvez fournir à un agent et explique comment configurer chaque source.

Ces conseils s'appliquent au Microsoft Game Development Kit (GDK) et au Microsoft GDK avec XBOX Extensions (GDKX) sur un ordinateur de développement PC Windows.

## Avant de commencer

* Installez le GDK. Les exemples utilisent le GDK d'octobre 2026 (édition `261000`). Remplacez `261000` par l'édition avec laquelle votre jeu est compilé.
* Utilisez un agent capable de se connecter à un serveur MCP (Model Context Protocol), de lire des fichiers sur votre ordinateur ou d'exécuter des commandes. La plupart des agents de codage peuvent faire les trois.
* Renseignez-vous sur les outils d'IA que votre organisation approuve pour le contenu confidentiel. La documentation, les en-têtes et les outils du GDKX sont confidentiels.

## Choisir le contexte GDK à fournir à l'agent

| Source | Ce que l'agent obtient | Version | Accès |
| - | - | - | - |
| Serveur MCP de la documentation XBOX | Recherche et récupération dans la documentation XBOX publiée | Documentation en ligne actuelle | Public |
| `llms.txt`, `llms-full.txt` et pages Markdown | Un index de toutes les pages, le texte intégral de la documentation ou une page en Markdown | Documentation en ligne actuelle | Public |
| Documentation Markdown hors ligne | La documentation du GDK sous forme de fichiers Markdown | Correspond au GDK installé | Pages publiques et confidentielles |
| En-têtes installés | Déclarations exactes et, dans certains en-têtes, commentaires de documentation | Correspond au GDK installé | Correspond au GDK que vous avez installé |
| Outils en ligne de commande | Texte d'utilisation et descriptions d'erreurs fournis par les outils eux-mêmes | Correspond au GDK installé | Correspond au GDK que vous avez installé |
| [Exemples XBOX GDK](https://github.com/microsoft/Xbox-GDK-Samples) | Exemples complets et compilables | Étiquetés par version du GDK | Public |

Les sources en ligne décrivent le GDK actuel. Lorsque vous compilez avec un GDK antérieur, fournissez aussi à l'agent les en-têtes installés et la documentation hors ligne, afin qu'il n'utilise pas d'API que votre GDK ne contient pas.

## Connecter le serveur MCP de la documentation XBOX

Le serveur MCP de la documentation XBOX, à l'adresse `https://docs.xbox.com/mcp`, permet à un agent de rechercher et de citer la documentation publiée. Il ne nécessite ni clé API ni connexion. Par exemple, dans Visual Studio Code, ajoutez le serveur à un fichier `.vscode/mcp.json` dans votre projet :

```json .vscode/mcp.json theme={null}
{
  "servers": {
    "xbox-docs": {
      "type": "http",
      "url": "https://docs.xbox.com/mcp"
    }
  }
}
```

Pour connaître les étapes de configuration de Claude Code, GitHub Copilot CLI, Cursor, Codex et Claude, consultez [Utiliser cette documentation avec des outils d'IA](https://docs.xbox.com/fr-CA.md#xbox-home-ai-title) sur la page d'accueil.

Les agents qui ne peuvent pas utiliser MCP peuvent lire la documentation dans d'autres formats :

* `https://docs.xbox.com/llms.txt` répertorie toutes les pages avec une courte description.
* `https://docs.xbox.com/llms-full.txt` contient le texte intégral de la documentation dans un seul fichier.
* Ajoutez `.md` à la fin de l'URL de n'importe quelle page pour obtenir cette page en Markdown.

## Fournir à l'agent la documentation hors ligne

Le GDKX installe la documentation du GDK sous forme de fichiers Markdown dans `GDKDocumentationMarkdown.zip`, dans le dossier `xbox\documentation` de l'édition du GDK. Comme ces fichiers correspondent au GDK que vous avez installé, ils constituent la source de documentation la plus exacte pour cette version.

Chaque page commence par un bloc frontmatter YAML. La valeur `permissioned-type` indique la classification d'accès de la page : `public`, `private` ou `secret`. Le fichier `site-map.md`, à la racine de l'archive, répertorie les pages.

> [!WARNING]
>
> L'archive contient des pages confidentielles. Utilisez l'archive complète uniquement avec des outils d'IA que votre organisation approuve pour le contenu confidentiel du GDKX. N'ajoutez pas les fichiers extraits à un dépôt public ni à un emplacement accessible en lecture à des personnes de l'extérieur de votre organisation.

1. Extrayez l'archive dans un dossier situé à l'extérieur de votre dépôt de code source. Dans PowerShell, exécutez les commandes suivantes.

   ```powershell theme={null}
   $edition = '261000'
   $zip  = Join-Path $env:GameDK "$edition\xbox\documentation\GDKDocumentationMarkdown.zip"
   $dest = "$env:USERPROFILE\gdk-docs\$edition"
   Expand-Archive -Path $zip -DestinationPath $dest
   ```

2. Si votre outil d'IA n'est pas approuvé pour le contenu confidentiel, conservez uniquement les pages publiques. La commande suivante supprime tous les fichiers Markdown dont la valeur `permissioned-type` n'est pas `public`, y compris les fichiers qui n'ont pas ce champ.

   ```powershell theme={null}
   Get-ChildItem $dest -Recurse -Filter *.md |
     Where-Object { -not (Get-Content $_.FullName -TotalCount 25 |
       Select-String -Quiet '^permissioned-type:\s*public\s*$') } |
     Remove-Item
   ```

3. Donnez à l'agent l'accès au dossier. Par exemple, ajoutez-le à l'espace de travail de votre éditeur ou mentionnez-le dans votre fichier d'instructions de projet.

Extrayez de nouveau l'archive pour chaque édition du GDK que vous installez, dans un dossier nommé d'après cette édition.

## Diriger l'agent vers les en-têtes et les outils installés

Le programme d'installation du GDK définit des variables d'environnement qui indiquent à l'agent l'emplacement du GDK installé :

* `GameDK` est le dossier racine du GDK. Il contient le dossier `bin` des outils en ligne de commande et un dossier pour chaque édition installée, comme `%GameDK%261000\`.
* `GameDKCoreLatest` et `GameDKXboxLatest` pointent vers l'édition installée la plus récente.

Lorsque plusieurs éditions sont installées côte à côte, l'édition la plus récente n'est pas nécessairement celle avec laquelle votre jeu est compilé. Fournissez à l'agent le dossier de l'édition utilisée par votre jeu, comme `%GameDK%261000\`, plutôt que ces variables.

Pour connaître les dossiers de chaque édition, consultez [Structure des répertoires d'en-têtes et de bibliothèques du GDK](https://docs.xbox.com/fr-CA/build/gdk-and-engines/guides/gdk-directory-structure.md). Demandez à l'agent de vérifier les déclarations dans les en-têtes du dossier `windows\include` de l'édition pour PC, ou de son dossier `xbox\include` pour les consoles XBOX, avant d'utiliser une API. Certains en-têtes, comme ceux de l'API des services XBOX (XSAPI), de libHttpClient et de PlayFab, comprennent aussi des commentaires de documentation qui décrivent chaque API.

Les outils en ligne de commande de `%GameDK%bin` affichent leur mode d'emploi lorsque vous les exécutez avec `/?`. Un agent peut exécuter `/?` sur un outil avant de l'utiliser, au lieu de deviner ses options. Pour traduire un `HRESULT` en description, utilisez `xberror.exe` :

```cmd theme={null}
"%GameDK%bin\xberror.exe" 0x8015DC12
```

## Fournir à l'agent un exemple de code adapté à votre version

Utilisez la [liste des exemples XBOX GDK](https://github.com/microsoft/Xbox-GDK-Samples/blob/main/gdk-samples-list.md) pour trouver des exemples de la fonctionnalité que vous mettez en œuvre. Consultez les fichiers README du dépôt et des exemples pour connaître la version du GDK, la disposition des répertoires et la configuration requise des plateformes. Si la branche principale ne correspond pas à votre projet, choisissez une [version des exemples](https://github.com/microsoft/Xbox-GDK-Samples/releases) compatible.

Clonez ou téléchargez la version compatible et fournissez à l'agent les chemins locaux du code source et du fichier README de l'exemple pertinent. Demandez-lui de suivre les modèles de l'exemple pour l'initialisation, la gestion des erreurs, la durée de vie des opérations asynchrones et le nettoyage. Demandez à l'agent de vérifier les API dans vos en-têtes installés plutôt que de copier les paramètres de projet d'une autre disposition du GDK.

## Laisser l'agent compiler à partir de la ligne de commande

Pour compiler, un agent a besoin du même environnement qu'une invite de commandes Gaming. Exécutez `GamingDesktopVars.cmd` avec les arguments qu'utilise le raccourci du menu Démarrer, puis exécutez la compilation dans le même processus `cmd` :

```cmd theme={null}
cmd /c ""%GameDK%Command Prompts\GamingDesktopVars.cmd" GamingDesktopVS2026 261000 && msbuild MyGame.sln /p:Configuration=Debug /p:Platform=Gaming.Desktop.x64"
```

Utilisez `GamingDesktopVS2022` pour Visual Studio 2022. L'environnement n'est pas conservé d'une commande distincte à l'autre; l'agent doit donc exécuter le script et la compilation ensemble.

## Ajouter un fichier d'instructions de projet

La plupart des agents de codage lisent un fichier d'instructions de projet, comme `AGENTS.md` ou `.github/copilot-instructions.md`, à la racine de votre dépôt. Utilisez-le pour fournir le même contexte GDK à chaque session de l'agent. Partez de l'exemple suivant et remplacez les valeurs entre chevrons.

```markdown AGENTS.md theme={null}
# GDK project instructions

- This game uses the Microsoft Game Development Kit (GDK) <edition, for example 261000 (October 2026)>.
  Target platforms: <Gaming.Desktop.x64, Gaming.Xbox.Scarlett.x64>.
- Before you use a GDK API, check its declaration in the headers of this edition:
  %GameDK%<edition>\windows\include for PC and %GameDK%<edition>\xbox\include for XBOX consoles.
  Don't use an API that the headers for the target platform don't declare.
- Search the XBOX docs with the xbox-docs MCP server. For the documentation of this GDK
  edition, read the Markdown files in <%USERPROFILE%\gdk-docs\261000>.
- Use the sample source and README in <local path to a compatible XBOX GDK sample>.
  Check its GDK version, directory layout, and platform requirements before adapting code.
- Build: cmd /c ""%GameDK%Command Prompts\GamingDesktopVars.cmd" GamingDesktopVS2026 <edition> && msbuild <solution> /p:Platform=Gaming.Desktop.x64"
- Run a GDK tool with /? before you use it. Translate HRESULT values with xberror.
- Before handing back a change, review the diff for correctness and unintended changes.
  Run the build and relevant tests. Report the commands, results, and anything you couldn't verify.
- Don't copy confidential GDKX content into public files or into tools that aren't approved for it.
```

## Examiner le travail de l'agent

Avant d'examiner une modification, demandez à l'agent d'examiner lui-même son travail. Par exemple, donnez-lui cette requête :

```text theme={null}
Review your diff against the task and project instructions before handing it back.
Check HRESULT handling, asynchronous completion or cancellation, resource cleanup,
and API availability in the installed GDK edition for each target platform.
Look for unintended behavior changes and missing tests for the changed behavior.
Fix the issues you find, then run the build and relevant tests for the affected targets.
Report remaining concerns, the exact commands and results, and anything you couldn't verify.
Don't claim a build, test, or platform check passed unless you ran it successfully.
```

L'autoexamen ne remplace pas votre propre examen. Examinez et testez le code écrit par un agent comme vous le feriez pour tout autre code. Vérifiez dans la documentation, et non dans la réponse de l'agent, les affirmations concernant la prise en charge des plateformes, les politiques et les exigences de certification.

## Voir aussi

* [Structure des répertoires d'en-têtes et de bibliothèques du GDK](https://docs.xbox.com/fr-CA/build/gdk-and-engines/guides/gdk-directory-structure.md)
* [Démarrer le développement d'un nouveau titre à l'aide des modèles de projet du GDK](https://docs.xbox.com/fr-CA/build/gdk-and-engines/guides/gdk-project-templates.md)
* [Exemples XBOX GDK sur GitHub](https://github.com/microsoft/Xbox-GDK-Samples)


## Related topics

- [DevKit Agent pour la gestion des kits de développement XBOX](https://docs.xbox.com/fr-CA/tools/tools-console/devkitagent/devkitagent-overview.md)
- [Utiliser le GDK avec Unity, Unreal et d'autres moteurs](https://docs.xbox.com/fr-CA/build/gdk-and-engines/gdk-and-engines.md)
- [Utiliser Clang avec le Microsoft Game Development Kit (GDK)](https://docs.xbox.com/fr-CA/tools/tools-pc/visualstudio/gr-vs-clang.md)
- [Compiler et exécuter votre premier titre console GDKX](https://docs.xbox.com/fr-CA/home/build-first-title/first-console-title-walkthrough.md)
- [Utiliser Clang avec le Microsoft Game Development Kit (GDK) pour les consoles](https://docs.xbox.com/fr-CA/tools/tools-console/visualstudio/vs-clang.md)
