{"meta":{"title":"Gancho de uso de pré-ferramenta","intro":"O onPreToolUse gancho é chamado antes da execução de uma ferramenta. Use-o para:","product":"GitHub Copilot","breadcrumbs":[{"href":"/pt/copilot","title":"GitHub Copilot"},{"href":"/pt/copilot/how-tos","title":"Instruções"},{"href":"/pt/copilot/how-tos/copilot-sdk","title":"SDK do Copilot"},{"href":"/pt/copilot/how-tos/copilot-sdk/hooks","title":"Usar ganchos"},{"href":"/pt/copilot/how-tos/copilot-sdk/hooks/pre-tool-use","title":"Pré-uso da ferramenta"}],"documentType":"article"},"body":"# Gancho de uso de pré-ferramenta\n\nO onPreToolUse gancho é chamado antes da execução de uma ferramenta. Use-o para:\n\n\n\n\n\n* Aprovar ou negar a execução da ferramenta\n* Modificar argumentos de ferramenta\n* Adicionar contexto para a ferramenta\n* Suprimir a saída da ferramenta da conversa\n\n## Assinatura de 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## Entrada\n\n| Campo | Tipo | Description |\n| ----------- | ------ | ------------------------------------------------------------- |\n| `timestamp` | número | Carimbo de data/hora Unix de quando o gancho foi desencadeado |\n| `cwd` | cadeia | Diretório de trabalho atual |\n| `toolName` | cadeia | Nome da ferramenta que está sendo chamada |\n| `toolArgs` | objeto | Argumentos passados para a ferramenta |\n\n## Saída\n\nRetornar `null` ou `undefined` para permitir que a ferramenta seja executada sem alterações. Caso contrário, retorne um objeto com qualquer um desses campos:\n\n| Campo | Tipo | Description |\n| ---------------------------------------- | ------- | ---------------------------------------------------------------------- |\n| `permissionDecision` | | |\n| `\"allow\"` | | |\n| \\| | | |\n| `\"deny\"` | | |\n| \\| | | |\n| `\"ask\"` | | |\n| Se deve permitir a chamada de ferramenta | | |\n| `permissionDecisionReason` | cadeia | Explicação mostrada ao usuário (para negar/perguntar) |\n| `modifiedArgs` | objeto | Argumentos modificados a serem passados para a ferramenta |\n| `additionalContext` | cadeia | Contexto extra injetado na conversa |\n| `suppressOutput` | boolean | Se for verdadeiro, o resultado da ferramenta não aparecerá na conversa |\n\n### Decisões de permissão\n\n| Decisão | Behavior |\n| --------- | ------------------------------------------------------- |\n| `\"allow\"` | A ferramenta é executada normalmente |\n| `\"deny\"` | A ferramenta está bloqueada, motivo mostrado ao usuário |\n| `\"ask\"` | O usuário é solicitado a aprovar (modo interativo) |\n\n### Ignorando solicitações de permissão para ferramentas personalizadas confiáveis\n\nSe você definir uma ferramenta personalizada que seja segura para ser executada sem solicitação, defina `skipPermission: true` na definição da ferramenta. Use isto para ferramentas confiáveis pertencentes ao aplicativo, cujas entradas já são controladas pelo seu aplicativo; use `onPreToolUse` quando precisar de verificações de política a cada chamada ou validação de argumentos.\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## Exemplos\n\n### Permitir todas as ferramentas (somente registro em log)\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### Bloquear ferramentas específicas\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### Modificar argumentos de ferramenta\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### Restringir o acesso a arquivos a diretórios específicos\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### Suprimir a saída detalhada da ferramenta\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### Adicionar contexto com base na ferramenta\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## Práticas recomendadas\n\n1. **Sempre retornar uma decisão** – retornar `null` permite a ferramenta, mas ser explícito com `{ permissionDecision: \"allow\" }` é mais claro.\n\n2. **Fornecer razões úteis de negação** – ao negar, explique por que os usuários entendem:\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. **Tenha cuidado com a modificação do argumento** – verifique se os args modificados mantêm o esquema esperado para a ferramenta.\n\n4. **Considere o desempenho** - Os hooks de pré-ferramenta são executados de forma síncrona antes de cada chamada à ferramenta. Mantenha-os rápidos.\n\n5. **Use `suppressOutput` de forma criteriosa** – suprimir a saída significa que o modelo não verá o resultado, o que pode afetar a qualidade da conversa.\n\n## Consulte também\n\n* [Usar ganchos](/pt/copilot/how-tos/copilot-sdk/hooks)\n* [Gancho de uso pós-ferramenta](/pt/copilot/how-tos/copilot-sdk/hooks/post-tool-use)\n* [Guia de depuração](/pt/copilot/how-tos/copilot-sdk/troubleshooting/debugging)"}