{"meta":{"title":"Gancho previo al uso de la herramienta","intro":"Se llama al enlace onPreToolUse antes de que se ejecute una herramienta. Úselo para:","product":"GitHub Copilot","breadcrumbs":[{"href":"/es/copilot","title":"GitHub Copilot"},{"href":"/es/copilot/how-tos","title":"Procedimientos"},{"href":"/es/copilot/how-tos/copilot-sdk","title":"SDK de Copilot"},{"href":"/es/copilot/how-tos/copilot-sdk/hooks","title":"Uso de enlaces"},{"href":"/es/copilot/how-tos/copilot-sdk/hooks/pre-tool-use","title":"Antes de usar la herramienta"}],"documentType":"article"},"body":"# Gancho previo al uso de la herramienta\n\nSe llama al enlace onPreToolUse antes de que se ejecute una herramienta. Úselo para:\n\n\n\n\n\n* Aprobación o denegación de la ejecución de la herramienta\n* Modificación de argumentos de herramienta\n* Adición de contexto para la herramienta\n* Suprimir la salida de la herramienta de la conversación\n\n## Firma de enlace\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 | Marca de tiempo de Unix cuando se desencadenó el enlace |\n| `cwd` | string | Directorio de trabajo actual |\n| `toolName` | string | Nombre de la herramienta invocada |\n| `toolArgs` | object | Argumentos pasados a la herramienta |\n\n## Output\n\nDevuelve `null` o `undefined` permite que la herramienta se ejecute sin cambios. De lo contrario, devuelve un objeto con cualquiera de estos campos:\n\n| Campo | Tipo | Description |\n| ------------------------------------------------------ | ------- | ---------------------------------------------------------------------------- |\n| `permissionDecision` | | |\n| `\"allow\"` | | |\n| \\| | | |\n| `\"deny\"` | | |\n| \\| | | |\n| `\"ask\"` | | |\n| Indica si se va a permitir la llamada a la herramienta | | |\n| `permissionDecisionReason` | string | Explicación que se muestra al usuario (para denegar o pedir) |\n| `modifiedArgs` | object | Argumentos modificados para pasar a la herramienta |\n| `additionalContext` | string | Contexto adicional insertado en la conversación |\n| `suppressOutput` | boolean | Si es verdadero, la salida de la herramienta no aparecerá en la conversación |\n\n### Decisiones de permisos\n\n| Decisión | Comportamiento |\n| --------- | --------------------------------------------------------------- |\n| `\"allow\"` | La herramienta se ejecuta normalmente |\n| `\"deny\"` | La herramienta está bloqueada, motivo que se muestra al usuario |\n| `\"ask\"` | Se pide al usuario que apruebe (modo interactivo) |\n\n### Omitir solicitudes de permisos para herramientas personalizadas de confianza\n\nSi define una herramienta personalizada que es segura para ejecutarse sin preguntar, establezca `skipPermission: true` en la definición de la herramienta. Utilízala para herramientas de confianza propiedad de la aplicación cuyos datos de entrada ya estén restringidos por tu aplicación; utiliza `onPreToolUse` cuando necesites comprobaciones de directivas o validación de argumentos por llamada.\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## Ejemplos\n\n### Permitir todas las herramientas (solo registro)\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 herramientas 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### Modificación de argumentos de herramienta\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### Restricción del acceso a archivos a directorios 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 la salida detallada de la herramienta\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### Añadir contexto según la herramienta\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## procedimientos recomendados\n\n1. **Devolver siempre una decisión** : devolver `null` permite la herramienta, pero ser explícito con `{ permissionDecision: \"allow\" }` es más claro.\n\n2. **Proporcionar razones de denegación útiles** : al denegar, explique por qué para que los usuarios comprendan:\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. **Tenga cuidado con la modificación de argumentos** : asegúrese de que los argumentos modificados mantienen el esquema esperado para la herramienta.\n\n4. **Tenga en cuenta el rendimiento** - Los hooks previos a la herramienta se ejecutan de forma síncrona antes de cada llamada a la herramienta. Manténgalos rápidos.\n\n5. **Usar `suppressOutput` con criterio** : suprimir la salida significa que el modelo no verá el resultado, lo que puede afectar a la calidad de la conversación.\n\n## Consulte también\n\n* [Uso de enlaces](/es/copilot/how-tos/copilot-sdk/hooks)\n* [Enlace de uso posterior a la herramienta](/es/copilot/how-tos/copilot-sdk/hooks/post-tool-use)\n* [Guía de depuración](/es/copilot/how-tos/copilot-sdk/troubleshooting/debugging)"}