TypeScript
```typescript
type PreToolUseHandler = (
input: PreToolUseHookInput,
invocation: HookInvocation
) => Promise
;
```
Python
```python
PreToolUseHandler = Callable[
[PreToolUseHookInput, dict[str, str]],
Awaitable[PreToolUseHookOutput | None]
]
```
Go
```golang
type PreToolUseHandler func(
input PreToolUseHookInput,
invocation HookInvocation,
) (*PreToolUseHookOutput, error)
```
.NET
```csharp
public delegate Task
PreToolUseHandler(
PreToolUseHookInput input,
HookInvocation invocation);
```
Java
```java
@FunctionalInterface
public interface PreToolUseHandler {
CompletableFuture
handle(
PreToolUseHookInput input,
HookInvocation invocation);
}
```
## Entrada
| Campo | Tipo | Description |
| ----------- | ------ | ------------------------------------------------------- |
| `timestamp` | número | Marca de tiempo de Unix cuando se desencadenó el enlace |
| `cwd` | string | Directorio de trabajo actual |
| `toolName` | string | Nombre de la herramienta invocada |
| `toolArgs` | object | Argumentos pasados a la herramienta |
## Output
Devuelve `null` o `undefined` permite que la herramienta se ejecute sin cambios. De lo contrario, devuelve un objeto con cualquiera de estos campos:
| Campo | Tipo | Description |
| ------------------------------------------------------ | ------- | ---------------------------------------------------------------------------- |
| `permissionDecision` | | |
| `"allow"` | | |
| \| | | |
| `"deny"` | | |
| \| | | |
| `"ask"` | | |
| Indica si se va a permitir la llamada a la herramienta | | |
| `permissionDecisionReason` | string | Explicación que se muestra al usuario (para denegar o pedir) |
| `modifiedArgs` | object | Argumentos modificados para pasar a la herramienta |
| `additionalContext` | string | Contexto adicional insertado en la conversación |
| `suppressOutput` | boolean | Si es verdadero, la salida de la herramienta no aparecerá en la conversación |
### Decisiones de permisos
| Decisión | Comportamiento |
| --------- | --------------------------------------------------------------- |
| `"allow"` | La herramienta se ejecuta normalmente |
| `"deny"` | La herramienta está bloqueada, motivo que se muestra al usuario |
| `"ask"` | Se pide al usuario que apruebe (modo interactivo) |
### Omitir solicitudes de permisos para herramientas personalizadas de confianza
Si 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.
```typescript
const getWeather = defineTool("get_weather", {
description: "Get weather for a location.",
parameters: {
type: "object",
properties: { location: { type: "string" } },
required: ["location"],
},
skipPermission: true,
handler: async ({ location }) => ({ forecast: `Sunny in ${location}` }),
});
```
## Ejemplos
### Permitir todas las herramientas (solo registro)
TypeScript
```typescript
const session = await client.createSession({
hooks: {
onPreToolUse: async (input, invocation) => {
console.log(`[${invocation.sessionId}] Calling ${input.toolName}`);
console.log(` Args: ${JSON.stringify(input.toolArgs)}`);
return { permissionDecision: "allow" };
},
},
});
```
Python
```python
from copilot.session import PermissionHandler
async def on_pre_tool_use(input_data, invocation):
print(f"[{invocation['session_id']}] Calling {input_data['toolName']}")
print(f" Args: {input_data['toolArgs']}")
return {"permissionDecision": "allow"}
session = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={"on_pre_tool_use": on_pre_tool_use})
```
Go
```golang
session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{
Hooks: &copilot.SessionHooks{
OnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {
fmt.Printf("[%s] Calling %s\n", inv.SessionID, input.ToolName)
fmt.Printf(" Args: %v\n", input.ToolArgs)
return &copilot.PreToolUseHookOutput{
PermissionDecision: "allow",
}, nil
},
},
})
```
.NET
```csharp
var session = await client.CreateSessionAsync(new SessionConfig
{
Hooks = new SessionHooks
{
OnPreToolUse = (input, invocation) =>
{
Console.WriteLine($"[{invocation.SessionId}] Calling {input.ToolName}");
Console.WriteLine($" Args: {input.ToolArgs}");
return Task.FromResult
(
new PreToolUseHookOutput { PermissionDecision = "allow" }
);
},
},
});
```
Java
```java
import com.github.copilot.*;
import com.github.copilot.rpc.*;
import java.util.concurrent.CompletableFuture;
var hooks = new SessionHooks()
.setOnPreToolUse((input, invocation) -> {
System.out.println("[" + invocation.getSessionId() + "] Calling " + input.getToolName());
System.out.println(" Args: " + input.getToolArgs());
return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());
});
var session = client.createSession(
new SessionConfig()
.setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setHooks(hooks)
).get();
```
### Bloquear herramientas específicas
```typescript
const BLOCKED_TOOLS = ["shell", "bash", "write_file", "delete_file"];
const session = await client.createSession({
hooks: {
onPreToolUse: async (input) => {
if (BLOCKED_TOOLS.includes(input.toolName)) {
return {
permissionDecision: "deny",
permissionDecisionReason: `Tool '${input.toolName}' is not permitted in this environment`,
};
}
return { permissionDecision: "allow" };
},
},
});
```
### Modificación de argumentos de herramienta
```typescript
const session = await client.createSession({
hooks: {
onPreToolUse: async (input) => {
// Add a default timeout to all shell commands
if (input.toolName === "shell" && input.toolArgs) {
const args = input.toolArgs as { command: string; timeout?: number };
return {
permissionDecision: "allow",
modifiedArgs: {
...args,
timeout: args.timeout ?? 30000, // Default 30s timeout
},
};
}
return { permissionDecision: "allow" };
},
},
});
```
### Restricción del acceso a archivos a directorios específicos
```typescript
const ALLOWED_DIRECTORIES = ["/home/user/projects", "/tmp"];
const session = await client.createSession({
hooks: {
onPreToolUse: async (input) => {
if (input.toolName === "read_file" || input.toolName === "write_file") {
const args = input.toolArgs as { path: string };
const isAllowed = ALLOWED_DIRECTORIES.some(dir =>
args.path.startsWith(dir)
);
if (!isAllowed) {
return {
permissionDecision: "deny",
permissionDecisionReason: `Access to '${args.path}' is not permitted. Allowed directories: ${ALLOWED_DIRECTORIES.join(", ")}`,
};
}
}
return { permissionDecision: "allow" };
},
},
});
```
### Suprimir la salida detallada de la herramienta
```typescript
const VERBOSE_TOOLS = ["list_directory", "search_files"];
const session = await client.createSession({
hooks: {
onPreToolUse: async (input) => {
return {
permissionDecision: "allow",
suppressOutput: VERBOSE_TOOLS.includes(input.toolName),
};
},
},
});
```
### Añadir contexto según la herramienta
```typescript
const session = await client.createSession({
hooks: {
onPreToolUse: async (input) => {
if (input.toolName === "query_database") {
return {
permissionDecision: "allow",
additionalContext: "Remember: This database uses PostgreSQL syntax. Always use parameterized queries.",
};
}
return { permissionDecision: "allow" };
},
},
});
```
## procedimientos recomendados
1. **Devolver siempre una decisión** : devolver `null` permite la herramienta, pero ser explícito con `{ permissionDecision: "allow" }` es más claro.
2. **Proporcionar razones de denegación útiles** : al denegar, explique por qué para que los usuarios comprendan:
```typescript
return {
permissionDecision: "deny",
permissionDecisionReason: "Shell commands require approval. Please describe what you want to accomplish.",
};
```
3. **Tenga cuidado con la modificación de argumentos** : asegúrese de que los argumentos modificados mantienen el esquema esperado para la herramienta.
4. **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.
5. **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.
## Consulte también
* [Uso de enlaces](/es/copilot/how-tos/copilot-sdk/hooks)
* [Enlace de uso posterior a la herramienta](/es/copilot/how-tos/copilot-sdk/hooks/post-tool-use)
* [Guía de depuración](/es/copilot/how-tos/copilot-sdk/troubleshooting/debugging)