{"meta":{"title":"Hook exécuté avant l’utilisation d’un outil","intro":"Le onPreToolUse hook est appelé avant l’exécution d’un outil. Utilisez-le pour :","product":"GitHub Copilot","breadcrumbs":[{"href":"/fr/enterprise-cloud@latest/copilot","title":"GitHub Copilot"},{"href":"/fr/enterprise-cloud@latest/copilot/how-tos","title":"Procédures"},{"href":"/fr/enterprise-cloud@latest/copilot/how-tos/copilot-sdk","title":"Kit de développement logiciel (SDK) Copilot"},{"href":"/fr/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/hooks","title":"Utiliser des crochets"},{"href":"/fr/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/hooks/pre-tool-use","title":"Pré-utilisation de l’outil"}],"documentType":"article"},"body":"# Hook exécuté avant l’utilisation d’un outil\n\nLe onPreToolUse hook est appelé avant l’exécution d’un outil. Utilisez-le pour :\n\n\n\n\n\n* Approuver ou refuser l’exécution de l’outil\n* Modifier les arguments de l’outil\n* Ajouter un contexte pour l’outil\n* Supprimer la sortie de l’outil de la conversation\n\n## Signature du hook\n\n
\n
TypeScript
\n\n```typescript\ntype PreToolUseHandler = (\n input: PreToolUseHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
Python
\n\n```python\nPreToolUseHandler = Callable[\n [PreToolUseHookInput, dict[str, str]],\n Awaitable[PreToolUseHookOutput | None]\n]\n```\n\n
\n\n
Go
\n\n```golang\ntype PreToolUseHandler func(\n input PreToolUseHookInput,\n invocation HookInvocation,\n) (*PreToolUseHookOutput, error)\n```\n\n
\n\n
.NET
\n\n```csharp\npublic delegate Task PreToolUseHandler(\n PreToolUseHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
Java
\n\n```java\n@FunctionalInterface\npublic interface PreToolUseHandler {\n CompletableFuture handle(\n PreToolUseHookInput input,\n HookInvocation invocation);\n}\n```\n\n
\n\n
\n\n## Input\n\n| Champ | Catégorie | Description |\n| ----------- | --------- | ----------------------------------------------- |\n| `timestamp` | Numéro | Horodatage Unix lorsque le hook a été déclenché |\n| `cwd` | string | Répertoire de travail actuel |\n| `toolName` | string | Nom de l’outil appelé |\n| `toolArgs` | Objet | Arguments passés à l’outil |\n\n## Sortie\n\nRetournez `null` ou `undefined` autorisez l’outil à s’exécuter sans aucune modification. Sinon, retournez un objet avec l’un de ces champs :\n\n| Champ | Catégorie | Description |\n| ----------------------------------------- | --------- | ----------------------------------------------------------------------- |\n| `permissionDecision` | | |\n| `\"allow\"` | | |\n| \\| | | |\n| `\"deny\"` | | |\n| \\| | | |\n| `\"ask\"` | | |\n| Si l’on doit autoriser l’appel de l’outil | | |\n| `permissionDecisionReason` | string | Explication présentée à l’utilisateur (pour refuser/demander) |\n| `modifiedArgs` | Objet | Arguments modifiés pour passer à l’outil |\n| `additionalContext` | string | Contexte supplémentaire injecté dans la conversation |\n| `suppressOutput` | booléen | Si c’est vrai, la sortie de l’outil n’apparaît pas dans la conversation |\n\n### Décisions d’autorisation\n\n| Décision | Behavior |\n| --------- | ------------------------------------------------------ |\n| `\"allow\"` | L’outil s’exécute normalement |\n| `\"deny\"` | L’outil est bloqué, raison indiquée à l’utilisateur |\n| `\"ask\"` | L’utilisateur est invité à approuver (mode interactif) |\n\n### Ignorer les demandes d’autorisation pour les outils personnalisés fiables\n\nSi vous définissez un outil personnalisé pouvant être exécuté en toute sécurité sans demander de confirmation, définissez `skipPermission: true` dans la définition de l’outil. Utilisez-le pour les outils approuvés et appartenant à l’application dont les entrées sont déjà limitées par votre application ; utilisez `onPreToolUse` quand vous avez besoin de vérifications de stratégie par appel ou validation d’argument.\n\n```typescript\nconst getWeather = defineTool(\"get_weather\", {\n description: \"Get weather for a location.\",\n parameters: {\n type: \"object\",\n properties: { location: { type: \"string\" } },\n required: [\"location\"],\n },\n skipPermission: true,\n handler: async ({ location }) => ({ forecast: `Sunny in ${location}` }),\n});\n```\n\n## Exemples\n\n### Autoriser tous les outils (journalisation uniquement)\n\n
\n
TypeScript
\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input, invocation) => {\n console.log(`[${invocation.sessionId}] Calling ${input.toolName}`);\n console.log(` Args: ${JSON.stringify(input.toolArgs)}`);\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_pre_tool_use(input_data, invocation):\n print(f\"[{invocation['session_id']}] Calling {input_data['toolName']}\")\n print(f\" Args: {input_data['toolArgs']}\")\n return {\"permissionDecision\": \"allow\"}\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_pre_tool_use\": on_pre_tool_use})\n```\n\n
\n\n
Go
\n\n```golang\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n fmt.Printf(\"[%s] Calling %s\\n\", inv.SessionID, input.ToolName)\n fmt.Printf(\" Args: %v\\n\", input.ToolArgs)\n return &copilot.PreToolUseHookOutput{\n PermissionDecision: \"allow\",\n }, nil\n },\n },\n})\n```\n\n
\n\n
.NET
\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] Calling {input.ToolName}\");\n Console.WriteLine($\" Args: {input.ToolArgs}\");\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" }\n );\n },\n },\n});\n```\n\n
\n\n
Java
\n\n\n\n```java\nimport com.github.copilot.*;\nimport com.github.copilot.rpc.*;\nimport java.util.concurrent.CompletableFuture;\n\nvar hooks = new SessionHooks()\n .setOnPreToolUse((input, invocation) -> {\n System.out.println(\"[\" + invocation.getSessionId() + \"] Calling \" + input.getToolName());\n System.out.println(\" Args: \" + input.getToolArgs());\n return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());\n });\n\nvar session = client.createSession(\n new SessionConfig()\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n .setHooks(hooks)\n).get();\n```\n\n
\n\n
\n\n### Bloquer des outils spécifiques\n\n```typescript\nconst BLOCKED_TOOLS = [\"shell\", \"bash\", \"write_file\", \"delete_file\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (BLOCKED_TOOLS.includes(input.toolName)) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: `Tool '${input.toolName}' is not permitted in this environment`,\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Modifier les arguments de l’outil\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n // Add a default timeout to all shell commands\n if (input.toolName === \"shell\" && input.toolArgs) {\n const args = input.toolArgs as { command: string; timeout?: number };\n return {\n permissionDecision: \"allow\",\n modifiedArgs: {\n ...args,\n timeout: args.timeout ?? 30000, // Default 30s timeout\n },\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Restreindre l’accès aux fichiers à des répertoires spécifiques\n\n```typescript\nconst ALLOWED_DIRECTORIES = [\"/home/user/projects\", \"/tmp\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (input.toolName === \"read_file\" || input.toolName === \"write_file\") {\n const args = input.toolArgs as { path: string };\n const isAllowed = ALLOWED_DIRECTORIES.some(dir => \n args.path.startsWith(dir)\n );\n \n if (!isAllowed) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: `Access to '${args.path}' is not permitted. Allowed directories: ${ALLOWED_DIRECTORIES.join(\", \")}`,\n };\n }\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Réduire la sortie verbeuse de l’outil\n\n```typescript\nconst VERBOSE_TOOLS = [\"list_directory\", \"search_files\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n return {\n permissionDecision: \"allow\",\n suppressOutput: VERBOSE_TOOLS.includes(input.toolName),\n };\n },\n },\n});\n```\n\n### Ajouter un contexte basé sur l’outil\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (input.toolName === \"query_database\") {\n return {\n permissionDecision: \"allow\",\n additionalContext: \"Remember: This database uses PostgreSQL syntax. Always use parameterized queries.\",\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n## Bonnes pratiques\n\n1. **Retournez toujours une décision** : renvoyer `null` autorise l’outil, mais utiliser explicitement `{ permissionDecision: \"allow\" }` est plus clair.\n\n2. **Fournir des raisons de refus utiles** : lorsque vous refusez, expliquez pourquoi les utilisateurs comprennent :\n\n ```typescript\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: \"Shell commands require approval. Please describe what you want to accomplish.\",\n };\n ```\n\n3. **Soyez prudent lors de la modification des arguments** - Assurez-vous que les arguments modifiés conservent le schéma attendu pour l’outil.\n\n4. **Tenez compte des performances** - Les hooks de pré-outil s’exécutent de manière synchrone avant chaque appel d’outil. Gardez-les rapidement.\n\n5. **Utiliser `suppressOutput` judicieusement** : la suppression de la sortie signifie que le modèle ne verra pas le résultat, ce qui peut affecter la qualité de la conversation.\n\n## Voir aussi\n\n* [Utiliser des crochets](/fr/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/hooks)\n* [Hook exécuté après l’utilisation d’un outil](/fr/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/hooks/post-tool-use)\n* [Guide de débogage](/fr/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/debugging)"}