Saltar al contenido principal
Los hooks son funciones de devolución de llamada que ejecutan su código en respuesta a eventos del agente, como una herramienta siendo llamada, una sesión iniciándose, o la ejecución deteniéndose. Con hooks, puede:
  • Bloquear operaciones peligrosas antes de que se ejecuten, como comandos de shell destructivos o acceso a archivos no autorizado
  • Registrar y auditar cada llamada de herramienta para cumplimiento, depuración o análisis
  • Transformar entradas y salidas para sanitizar datos, inyectar credenciales o redirigir rutas de archivos
  • Requerir aprobación humana para acciones sensibles como escrituras en bases de datos o llamadas a API
  • Rastrear el ciclo de vida de la sesión para gestionar estado, limpiar recursos o enviar notificaciones
Esta guía cubre cómo funcionan los hooks, cómo configurarlos, y proporciona ejemplos para patrones comunes como bloquear herramientas, modificar entradas y reenviar notificaciones.

Cómo funcionan los hooks

1

Se dispara un evento

Algo sucede durante la ejecución del agente y el SDK dispara un evento: una herramienta está a punto de ser llamada (PreToolUse), una herramienta devolvió un resultado (PostToolUse), un subagente se inició o se detuvo, el agente está inactivo, o la ejecución finalizó. Vea la lista completa de eventos.
2

El SDK recopila hooks registrados

El SDK verifica si hay hooks registrados para ese tipo de evento. Esto incluye hooks de devolución de llamada que pasa en options.hooks y hooks de comandos de shell de archivos de configuración cuando la entrada settingSources o setting_sources correspondiente está habilitada, lo cual lo está para las opciones predeterminadas de query().
3

Los matchers filtran qué hooks se ejecutan

Si un hook tiene un patrón matcher (como "Write|Edit"), el SDK lo prueba contra el objetivo del evento (por ejemplo, el nombre de la herramienta). Los hooks sin un matcher se ejecutan para cada evento de ese tipo.
4

Se ejecutan las funciones de devolución de llamada

Cada hook coincidente recibe su función de devolución de llamada con información sobre lo que está sucediendo: el nombre de la herramienta, sus argumentos, el ID de sesión y otros detalles específicos del evento.
5

Su devolución de llamada devuelve una decisión

Después de realizar cualquier operación (registro, llamadas a API, validación), su devolución de llamada devuelve un objeto de salida que le dice al agente qué hacer: permitir la operación, bloquearla, modificar la entrada o inyectar contexto en la conversación.
El siguiente ejemplo reúne estos pasos. Registra un hook PreToolUse (paso 1) con un matcher "Write|Edit" (paso 3) para que la devolución de llamada solo se dispare para herramientas de escritura de archivos. Cuando se activa, la devolución de llamada recibe la entrada de la herramienta (paso 4), verifica si la ruta del archivo apunta a un archivo .env, y devuelve permissionDecision: "deny" para bloquear la operación (paso 5):

Hooks disponibles

El SDK proporciona hooks para diferentes etapas de la ejecución del agente. Algunos hooks están disponibles en ambos SDK, mientras que otros son solo para TypeScript.

Configurar hooks

Para configurar un hook, páselo en el campo hooks de sus opciones de agente (ClaudeAgentOptions en Python, el objeto options en TypeScript):
La opción hooks es un diccionario en Python u objeto en TypeScript, donde:

Matchers

Use matchers para filtrar cuándo se disparan sus devoluciones de llamada. El campo matcher coincide con un valor diferente dependiendo del tipo de evento de hook. Por ejemplo, los hooks basados en herramientas coinciden con el nombre de la herramienta, mientras que los hooks Notification coinciden con el tipo de notificación. Vea la referencia de hooks de Claude Code para la lista completa de valores de matcher para cada tipo de evento. Los matchers del SDK siguen las mismas reglas que matchers en archivos de configuración. Un matcher que contiene solo letras, dígitos, _, -, espacios, , y | se compara como una cadena exacta, con alternativas separadas por | o , y espacios en blanco opcionales alrededor, por lo que Write|Edit y Write, Edit coinciden exactamente con esas dos herramientas y code-reviewer coincide solo con ese tipo de agente. Un matcher de *, una cadena vacía, u omitir el matcher completamente coincide con cada ocurrencia del evento. Un matcher que contiene cualquier otro carácter se evalúa como una expresión regular sin ancla, por lo que ^mcp__ coincide con cada herramienta MCP y Edit.* coincide tanto con Edit como con NotebookEdit. Envuelva una expresión regular en ^ y $ cuando necesite una coincidencia de cadena completa. Un matcher como mcp__memory o mcp__brave-search contiene solo caracteres de coincidencia exacta, por lo que se compara como una cadena exacta y no coincide con ninguna herramienta; use mcp__memory__.* para coincidir con cada herramienta de ese servidor. Los guiones en el conjunto de coincidencia exacta requieren un tiempo de ejecución de Claude Code v2.1.195 o posterior. En versiones anteriores, un nombre con guiones como code-reviewer se evalúa como una expresión regular sin ancla y debe anclarse como ^code-reviewer$ para coincidir exactamente. Use el patrón matcher para dirigirse a herramientas específicas siempre que sea posible. Un matcher con 'Bash' solo se ejecuta para comandos Bash, mientras que omitir el patrón ejecuta sus devoluciones de llamada para cada ocurrencia del evento. Para hooks basados en herramientas, los matchers solo filtran por nombre de herramienta, no por rutas de archivo u otros argumentos. Para filtrar por ruta de archivo, verifique tool_input.file_path dentro de su devolución de llamada.
Descubriendo nombres de herramientas: Vea Tipos de entrada de herramienta para la lista completa de nombres de herramientas integradas, o agregue un hook sin un matcher para registrar todas las llamadas de herramienta que su sesión realiza.Nomenclatura de herramientas MCP: Las herramientas MCP siempre comienzan con mcp__ seguido del nombre del servidor y la acción: mcp__<server>__<action>. Por ejemplo, si configura un servidor llamado playwright, sus herramientas se nombrarán mcp__playwright__browser_screenshot, mcp__playwright__browser_click y así sucesivamente. El nombre del servidor proviene de la clave que usa en la configuración mcpServers.

Funciones de devolución de llamada

Entradas

Cada devolución de llamada de hook recibe tres argumentos:
  • Datos de entrada: un objeto tipado que contiene detalles del evento. Cada tipo de hook tiene su propia forma de entrada. Por ejemplo, PreToolUseHookInput incluye tool_name y tool_input, mientras que NotificationHookInput incluye message. Vea las definiciones de tipo completas en las referencias del SDK de TypeScript y Python.
    • Todas las entradas de hook comparten session_id, cwd y hook_event_name.
    • agent_id y agent_type se rellenan cuando el hook se dispara dentro de un subagente. En TypeScript, estos están en la entrada de hook base y disponibles para todos los tipos de hook. En Python, son campos opcionales en PreToolUse, PostToolUse, PostToolUseFailure y PermissionRequest, y campos requeridos en SubagentStart y SubagentStop.
  • ID de uso de herramienta (str | None / string | undefined): correlaciona eventos PreToolUse y PostToolUse para la misma llamada de herramienta.
  • Contexto: en TypeScript, contiene una propiedad signal (AbortSignal) para cancelación. En Python, este argumento está reservado para uso futuro.

Salidas

Su devolución de llamada devuelve un objeto con dos categorías de campos:
  • Campos de nivel superior funcionan igual en cada evento: systemMessage muestra un mensaje al usuario, y continue (continue_ en Python) determina si el agente sigue ejecutándose después de este hook.
  • hookSpecificOutput controla la operación actual. Los campos dentro dependen del tipo de evento de hook. Para hooks PreToolUse, aquí es donde establece permissionDecision ("allow", "deny", "ask" o "defer"), permissionDecisionReason e updatedInput. Devolver "defer" finaliza la consulta para que pueda reanudarla más tarde. Para hooks PostToolUse, puede establecer additionalContext para agregar información al resultado de la herramienta. Para reemplazar la salida de la herramienta antes de que Claude la vea, establezca updatedToolOutput, que funciona para cualquier herramienta en ambos SDK. El campo anterior updatedMCPToolOutput reemplaza solo la salida de herramientas MCP y está deprecado.
Devuelva {} para permitir la operación sin cambios. Los hooks de devolución de llamada del SDK usan el mismo formato de salida JSON que hooks de comandos de shell de Claude Code, que documenta cada campo y opción específica del evento. Para las definiciones de tipo del SDK, vea las referencias del SDK de TypeScript y Python.
Cuando se aplican múltiples hooks o reglas de permiso, deny tiene prioridad sobre defer, que tiene prioridad sobre ask, que tiene prioridad sobre allow. Si algún hook devuelve deny, la operación se bloquea independientemente de otros hooks.

Salida asincrónica

De forma predeterminada, el agente espera a que su hook devuelva antes de continuar. Si su hook realiza un efecto secundario, como registro o envío de webhook, y no necesita influir en el comportamiento del agente, puede devolver una salida asincrónica en su lugar. Esto le dice al agente que continúe inmediatamente sin esperar a que el hook termine:
Las salidas asincrónicas no pueden bloquear, modificar o inyectar contexto en la operación ya que el agente ya ha avanzado. Úselas solo para efectos secundarios como registro, métricas o notificaciones.

Ejemplos

Modificar entrada de herramienta

Este ejemplo intercepta llamadas de herramienta Write y reescribe el argumento file_path para anteponer /sandbox, redirigiendo todas las escrituras de archivo a un directorio aislado. La devolución de llamada devuelve updatedInput con la ruta modificada y permissionDecision: 'allow' para aprobar automáticamente la operación reescrita:
Cuando use updatedInput, también debe incluir permissionDecision: 'allow' para aprobar automáticamente la entrada modificada o permissionDecision: 'ask' para mostrársela al usuario. Con 'defer', updatedInput se ignora. Siempre devuelva un nuevo objeto en lugar de mutar el tool_input original.

Agregar contexto y bloquear una herramienta

Este ejemplo bloquea escrituras en el directorio /etc y explica por qué tanto al modelo como al usuario:
  • permissionDecision: 'deny' detiene la llamada de herramienta.
  • permissionDecisionReason le dice al modelo por qué, para que evite reintentar.
  • systemMessage muestra al usuario qué sucedió.

Aprobar automáticamente herramientas específicas

De forma predeterminada, el agente puede solicitar permiso antes de usar ciertas herramientas. Este ejemplo aprueba automáticamente herramientas del sistema de archivos de solo lectura (Read, Glob, Grep) devolviendo permissionDecision: 'allow', permitiéndoles ejecutarse sin confirmación del usuario mientras deja todas las otras herramientas sujetas a verificaciones de permiso normales:

Registrar múltiples hooks

Cuando se dispara un evento, todos los hooks coincidentes se ejecutan en paralelo. Para decisiones de permiso, el resultado más restrictivo gana: un único deny bloquea la llamada de herramienta independientemente de lo que devuelvan los otros hooks. Debido a que el orden de finalización es no determinista, escriba cada hook para actuar de forma independiente en lugar de depender de que otro hook se haya ejecutado primero. El ejemplo a continuación registra tres verificaciones independientes para cada llamada de herramienta:

Filtrar con matchers de múltiples herramientas

Use matchers de múltiples herramientas para compartir una devolución de llamada entre herramientas relacionadas. Este ejemplo registra tres matchers con diferentes alcances:
  • Una lista exacta separada por tuberías (Write|Edit|Delete) dispara file_security_hook solo para herramientas de modificación de archivos.
  • Una expresión regular (^mcp__) dispara mcp_audit_hook para cualquier herramienta MCP cuyo nombre comience con mcp__.
  • Un matcher omitido dispara global_logger para cada llamada de herramienta independientemente del nombre.

Rastrear actividad de subagente

Use hooks SubagentStop para monitorear cuándo los subagentes terminan su trabajo. Vea el tipo de entrada completo en las referencias del SDK de TypeScript y Python. Este ejemplo registra un resumen cada vez que un subagente se completa:

Realizar solicitudes HTTP desde hooks

Los hooks pueden realizar operaciones asincrónicas como solicitudes HTTP. Capture errores dentro de su hook en lugar de dejarlos propagarse, ya que una excepción no manejada puede interrumpir el agente. Este ejemplo envía un webhook después de que cada herramienta se completa, registrando qué herramienta se ejecutó y cuándo. El hook captura errores para que un webhook fallido no interrumpa el agente:

Reenviar notificaciones a Slack

Use hooks Notification para recibir notificaciones del sistema del agente y reenviarlas a servicios externos. Las notificaciones se disparan para tipos de evento tales como:
  • permission_prompt cuando Claude necesita permiso
  • idle_prompt cuando Claude está esperando entrada
  • auth_success cuando la autenticación se completa
  • elicitation_dialog, elicitation_complete, y elicitation_response para flujos de elicitación de solicitud del usuario
Cada notificación incluye un campo message con una descripción legible por humanos y opcionalmente un title. Este ejemplo reenvía cada notificación a un canal de Slack. Requiere una URL de webhook entrante de Slack, que crea agregando una aplicación a su espacio de trabajo de Slack y habilitando webhooks entrantes:

Solucionar problemas comunes

Hook no se dispara

  • Verifique que el nombre del evento de hook sea correcto y sensible a mayúsculas (PreToolUse, no preToolUse)
  • Verifique que su patrón de matcher coincida exactamente con el nombre de la herramienta
  • Asegúrese de que el hook esté bajo el tipo de evento correcto en options.hooks
  • Para hooks que no son de herramientas que admiten matchers, como Notification y SubagentStop, los matchers coinciden contra campos diferentes, y Stop ignora los matchers por completo (vea patrones de matcher)
  • Los hooks pueden no dispararse cuando el agente alcanza el límite max_turns porque la sesión termina antes de que los hooks puedan ejecutarse

Matcher no filtra como se esperaba

Los matchers solo coinciden con nombres de herramientas, no con rutas de archivo u otros argumentos. Para filtrar por ruta de archivo, verifique tool_input.file_path dentro de su hook:

Tiempo de espera del hook

  • Aumente el valor timeout en la configuración HookMatcher
  • Use el AbortSignal del tercer argumento de devolución de llamada para manejar la cancelación correctamente en TypeScript
Una devolución de llamada UserPromptSubmit o UserPromptExpansion que excede su tiempo de espera bloquea ese mensaje con un mensaje de tiempo de espera y la sesión continúa. Interrumpir la consulta mientras una devolución de llamada está pendiente cancela la llamada de herramienta pendiente. Antes de v2.1.208, un tiempo de espera de devolución de llamada en esos eventos terminaba la consulta con error_during_execution, e interrumpir durante una devolución de llamada PreToolUse pendiente podría permitir que la llamada de herramienta procediera.

Herramienta bloqueada inesperadamente

  • Verifique todos los hooks PreToolUse para devoluciones de permissionDecision: 'deny'
  • Agregue registro a sus hooks para ver qué permissionDecisionReason están devolviendo
  • Verifique que los patrones de matcher no sean demasiado amplios: un matcher vacío coincide con todas las herramientas

Entrada modificada no aplicada

  • Asegúrese de que updatedInput esté dentro de hookSpecificOutput, no en el nivel superior:
  • Devuelva permissionDecision: 'allow' para aprobar automáticamente la entrada modificada, u 'ask' para mostrarla al usuario para su aprobación
  • Incluya hookEventName en hookSpecificOutput para identificar para qué tipo de hook es la salida

Hooks de sesión no disponibles en Python

SessionStart y SessionEnd pueden registrarse como hooks de devolución de llamada del SDK en TypeScript, pero no están disponibles en el SDK de Python porque su tipo HookEvent los omite. En Python, solo están disponibles como hooks de comandos de shell definidos en archivos de configuración como .claude/settings.json. Para cargar hooks de comandos de shell desde su aplicación SDK, incluya la fuente de configuración apropiada con setting_sources o settingSources:
Para ejecutar lógica de inicialización como una devolución de llamada del SDK de Python en su lugar, use el primer mensaje de client.receive_response() como su disparador.

Solicitudes de permiso de subagente multiplicándose

Al generar múltiples subagentes, cada uno puede solicitar permisos por separado. Los subagentes no heredan automáticamente los permisos del agente padre. Para evitar solicitudes repetidas, use hooks PreToolUse para aprobar automáticamente herramientas específicas, o configure reglas de permiso que se apliquen a sesiones de subagente.

Bucles recursivos de hook con subagentes

Un hook UserPromptSubmit que genera subagentes puede crear bucles infinitos si esos subagentes disparan el mismo hook. Para prevenir esto:
  • Verifique un indicador de subagente en la entrada del hook antes de generar
  • Use una variable compartida o estado de sesión para rastrear si ya está dentro de un subagente
  • Alcance los hooks para ejecutarse solo para la sesión del agente de nivel superior

systemMessage no aparece en la salida

El campo systemMessage muestra un mensaje al usuario, no al modelo. Por defecto, el SDK expone la salida de hooks en el flujo de mensajes solo para hooks SessionStart y Setup, por lo que un mensaje de cualquier otro evento de hook no aparece a menos que establezca includeHookEvents (include_hook_events en Python). Para pasar contexto al modelo en su lugar, devuelva additionalContext. Si necesita exponer decisiones de hook a su aplicación de manera confiable, regístrelas por separado o use un canal de salida dedicado.