Interceptar y controlar el comportamiento del agente con hooks

Los hooks te permiten interceptar la ejecución del agente en puntos clave para agregar validación, registro, controles de seguridad o lógica personalizada. Con hooks, puedes:

• 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 normativo, depuración o análisis
• Transformar entradas y salidas para desinfectar 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

Un hook tiene dos partes:

1. La función de devolución de llamada: la lógica que se ejecuta cuando se dispara el hook
2. La configuración del hook: le dice al SDK qué evento enganchar (como PreToolUse) y qué herramientas coinciden

El siguiente ejemplo bloquea al agente de modificar archivos .env. Primero, define una devolución de llamada que verifica la ruta del archivo, luego pásala a query() para ejecutarla antes de cualquier llamada de herramienta Write o Edit:

Este es un hook PreToolUse. Se ejecuta antes de que se ejecute la herramienta y puede bloquear u permitir operaciones basadas en tu lógica. El resto de esta guía cubre todos los hooks disponibles, sus opciones de configuración y patrones para casos de uso comunes.

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 de TypeScript porque el SDK de Python no los admite.

Casos de uso comunes

Los hooks son lo suficientemente flexibles para manejar muchos escenarios diferentes. Aquí hay algunos de los patrones más comunes organizados por categoría.

Configurar hooks

Para configurar un hook para tu agente, pasa el hook en el parámetro options.hooks al llamar a query():

async for message in query(
    prompt="Your prompt",
    options=ClaudeAgentOptions(
        hooks={
            'PreToolUse': [HookMatcher(matcher='Bash', hooks=[my_callback])]
        }
    )
):
    print(message)

La opción hooks es un diccionario (Python) u objeto (TypeScript) donde:

• Las claves son nombres de eventos de hook (por ejemplo, 'PreToolUse', 'PostToolUse', 'Stop')
• Los valores son matrices de matchers, cada una conteniendo un patrón de filtro opcional y tus funciones de devolución de llamada

Tus funciones de devolución de llamada de hook reciben datos de entrada sobre el evento y devuelven una respuesta para que el agente sepa si permitir, bloquear o modificar la operación.

Matchers

Usa matchers para filtrar qué herramientas disparan tus devoluciones de llamada:

Usa 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 tus devoluciones de llamada para cada llamada de herramienta. Ten en cuenta que los matchers solo filtran por nombre de herramienta, no por rutas de archivo u otros argumentos—para filtrar por ruta de archivo, verifica tool_input.file_path dentro de tu devolución de llamada.

Los matchers solo se aplican a hooks basados en herramientas (PreToolUse, PostToolUse, PostToolUseFailure, PermissionRequest). Para hooks de ciclo de vida como Stop, SessionStart y Notification, los matchers se ignoran y el hook se dispara para todos los eventos de ese tipo.

Este ejemplo usa un matcher para ejecutar un hook solo para herramientas que modifican archivos cuando se dispara el evento PreToolUse:

options = ClaudeAgentOptions(
    hooks={
        'PreToolUse': [
            HookMatcher(matcher='Write|Edit', hooks=[validate_file_path])
        ]
    }
)

Entradas de función de devolución de llamada

Cada devolución de llamada de hook recibe tres argumentos:

1. Datos de entrada (dict / HookInput): Detalles del evento. Consulta datos de entrada para los campos
2. ID de uso de herramienta (str | None / string | null): Correlaciona eventos PreToolUse y PostToolUse
3. Contexto (HookContext): En TypeScript, contiene una propiedad signal (AbortSignal) para cancelación. Pasa esto a operaciones asincrónicas como fetch() para que se cancelen automáticamente si el hook agota el tiempo. En Python, este argumento está reservado para uso futuro.

Datos de entrada

El primer argumento de tu devolución de llamada de hook contiene información sobre el evento. Los nombres de campo son idénticos en todos los SDK (ambos usan snake_case).

Campos comunes presentes en todos los tipos de hook:

Campos específicos del hook varían según el tipo de hook. Los elementos marcados ^TS solo están disponibles en el SDK de TypeScript:

El código siguiente define una devolución de llamada de hook que usa tool_name y tool_input para registrar detalles sobre cada llamada de herramienta:

Salidas de devolución de llamada

Tu función de devolución de llamada devuelve un objeto que le dice al SDK cómo proceder. Devuelve un objeto vacío {} para permitir la operación sin cambios. Para bloquear, modificar o agregar contexto a la operación, devuelve un objeto con un campo hookSpecificOutput que contiene tu decisión.

Campos de nivel superior (fuera de hookSpecificOutput):

Campos dentro de hookSpecificOutput:

Este ejemplo bloquea operaciones de escritura en el directorio /etc mientras inyecta un mensaje del sistema para recordarle a Claude sobre prácticas seguras de archivos:

Flujo de decisión de permisos

Cuando se aplican múltiples hooks o reglas de permisos, el SDK los evalúa en este orden:

1. Las reglas de negación se verifican primero (cualquier coincidencia = negación inmediata).
2. Las reglas de pregunta se verifican en segundo lugar.
3. Las reglas de permiso se verifican en tercer lugar.
4. Por defecto a Preguntar si nada coincide.

Si algún hook devuelve deny, la operación se bloquea—otros hooks que devuelven allow no lo anularán.

Bloquear una herramienta

Devuelve una decisión de negación para evitar la ejecución de la herramienta:

Modificar entrada de herramienta

Devuelve entrada actualizada para cambiar lo que recibe la herramienta:

Agregar un mensaje del sistema

Inyecta contexto en la conversación:

async def add_security_reminder(input_data, tool_use_id, context):
    return {
        'systemMessage': 'Remember to follow security best practices.'
    }

Aprobar automáticamente herramientas específicas

Omite solicitudes de permiso para herramientas de confianza. Esto es útil cuando deseas que ciertas operaciones se ejecuten sin confirmación del usuario:

Manejar escenarios avanzados

Estos patrones te ayudan a construir sistemas de hooks más sofisticados para casos de uso complejos.

Encadenar múltiples hooks

Los hooks se ejecutan en el orden en que aparecen en la matriz. Mantén cada hook enfocado en una única responsabilidad y encadena múltiples hooks para lógica compleja. Este ejemplo ejecuta los cuatro hooks para cada llamada de herramienta (sin matcher especificado):

Matchers específicos de herramienta con regex

Usa patrones regex para coincidir con múltiples herramientas:

Rastrear actividad de subagentes

Usa hooks SubagentStop para monitorear la finalización de subagentes. El tool_use_id ayuda a correlacionar llamadas de agente padre con sus subagentes:

Operaciones asincrónicas en hooks

Los hooks pueden realizar operaciones asincrónicas como solicitudes HTTP. Maneja errores correctamente capturando excepciones en lugar de lanzarlas. En TypeScript, pasa el signal a fetch() para que la solicitud se cancele si el hook agota el tiempo:

Enviar notificaciones (solo TypeScript)

Usa hooks Notification para recibir actualizaciones de estado del agente y reenviarlas a servicios externos como Slack o paneles de monitoreo:

import { query, HookCallback, NotificationHookInput } from "@anthropic-ai/claude-agent-sdk";

const notificationHandler: HookCallback = async (input, toolUseID, { signal }) => {
  const notification = input as NotificationHookInput;

  await fetch('https://hooks.slack.com/services/YOUR/WEBHOOK/URL', {
    method: 'POST',
    body: JSON.stringify({
      text: `Agent status: ${notification.message}`
    }),
    signal
  });

  return {};
};

for await (const message of query({
  prompt: "Analyze this codebase",
  options: {
    hooks: {
      Notification: [{ hooks: [notificationHandler] }]
    }
  }
})) {
  console.log(message);
}

Solucionar problemas comunes

Esta sección cubre problemas comunes y cómo resolverlos.

Hook no se dispara

• Verifica que el nombre del evento del hook sea correcto y sensible a mayúsculas (PreToolUse, no preToolUse)
• Comprueba que tu patrón de matcher coincida exactamente con el nombre de la herramienta
• Asegúrate de que el hook esté bajo el tipo de evento correcto en options.hooks
• Para hooks SubagentStop, Stop, SessionStart, SessionEnd y Notification, los matchers se ignoran. Estos hooks se disparan para todos los eventos de ese tipo.
• Los hooks pueden no dispararse cuando el agente alcanza el límite de 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, verifica tool_input.file_path dentro de tu hook:

const myHook: HookCallback = async (input, toolUseID, { signal }) => {
  const preInput = input as PreToolUseHookInput;
  const filePath = preInput.tool_input?.file_path as string;
  if (!filePath?.endsWith('.md')) return {};  // Skip non-markdown files
  // Process markdown files...
};

Tiempo de espera del hook

• Aumenta el valor de timeout en la configuración de HookMatcher
• Usa el AbortSignal del tercer argumento de devolución de llamada para manejar la cancelación correctamente en TypeScript

Herramienta bloqueada inesperadamente

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

Entrada modificada no aplicada

• Asegúrate de que updatedInput esté dentro de hookSpecificOutput, no en el nivel superior:

  return {
    hookSpecificOutput: {
      hookEventName: input.hook_event_name,
      permissionDecision: 'allow',
      updatedInput: { command: 'new command' }
    }
  };

• También debes devolver permissionDecision: 'allow' para que la modificación de entrada surta efecto

Hooks de sesión no disponibles

Los hooks SessionStart, SessionEnd y Notification solo están disponibles en el SDK de TypeScript. El SDK de Python no admite estos eventos debido a limitaciones de configuración.

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, usa hooks PreToolUse para aprobar automáticamente herramientas específicas, o configura reglas de permisos que se apliquen a sesiones de subagentes.

Bucles recursivos de hooks con subagentes

Un hook UserPromptSubmit que genera subagentes puede crear bucles infinitos si esos subagentes disparan el mismo hook. Para evitar esto:

• Verifica un indicador de subagente en la entrada del hook antes de generar
• Usa el campo parent_tool_use_id para detectar si ya estás en un contexto de subagente
• Limita los hooks para que solo se ejecuten en la sesión del agente de nivel superior

systemMessage no aparece en la salida

El campo systemMessage agrega contexto a la conversación que el modelo ve, pero puede no aparecer en todos los modos de salida del SDK. Si necesitas exponer decisiones de hooks a tu aplicación, regístralas por separado o usa un canal de salida dedicado.

Aprende más

• Permissions: control what your agent can do
• Custom Tools: build tools to extend agent capabilities
• TypeScript SDK Reference
• Python SDK Reference