SpyBara
Go Premium

agent-sdk/hooks.md 2026-05-13 23:01 UTC to 2026-05-14 17:02 UTC

11 added, 5 removed.

2026
Sun 31 06:39 Sat 30 06:23 Fri 29 06:38 Thu 28 06:37 Wed 27 06:42 Tue 26 06:33 Sun 24 06:25 Sat 23 06:18 Fri 22 06:33 Thu 21 06:36 Wed 20 06:35 Tue 19 06:34 Mon 18 23:59 Sun 17 01:01 Fri 15 22:58 Thu 14 17:02 Wed 13 23:01 Tue 12 22:57 Mon 11 23:00 Sun 10 23:03 Sat 9 04:57 Fri 8 22:00 Thu 7 22:59 Tue 5 23:00 Mon 4 22:58 Sat 2 18:14 Fri 1 18:19

Interceptar e controlar o comportamento do agente com hooks

Interceptar e personalizar o comportamento do agente em pontos-chave de execução com hooks

Hooks são funções de callback que executam seu código em resposta a eventos do agente, como uma ferramenta sendo chamada, uma sessão iniciando ou a execução parando. Com hooks, você pode:

  • Bloquear operações perigosas antes de serem executadas, como comandos shell destrutivos ou acesso a arquivos não autorizado
  • Registrar e auditar cada chamada de ferramenta para conformidade, depuração ou análise
  • Transformar entradas e saídas para sanitizar dados, injetar credenciais ou redirecionar caminhos de arquivo
  • Exigir aprovação humana para ações sensíveis como gravações em banco de dados ou chamadas de API
  • Rastrear ciclo de vida da sessão para gerenciar estado, limpar recursos ou enviar notificações

Este guia cobre como hooks funcionam, como configurá-los e fornece exemplos para padrões comuns como bloquear ferramentas, modificar entradas e encaminhar notificações.

Como hooks funcionam

1

Um evento é disparado

Algo acontece durante a execução do agente e o SDK dispara um evento: uma ferramenta está prestes a ser chamada (PreToolUse), uma ferramenta retornou um resultado (PostToolUse), um subagente iniciou ou parou, o agente está ocioso ou a execução terminou. Veja a lista completa de eventos.

2

O SDK coleta hooks registrados

O SDK verifica se há hooks registrados para esse tipo de evento. Isso inclui hooks de callback que você passa em options.hooks e hooks de comando shell de arquivos de configuração quando a entrada settingSources ou setting_sources correspondente está habilitada, o que é o padrão para opções query().

3

Matchers filtram quais hooks são executados

Se um hook tem um padrão matcher (como "Write|Edit"), o SDK o testa contra o alvo do evento (por exemplo, o nome da ferramenta). Hooks sem um matcher são executados para cada evento desse tipo.

4

Funções de callback são executadas

Cada função de callback do hook correspondente recebe informações sobre o que está acontecendo: o nome da ferramenta, seus argumentos, o ID da sessão e outros detalhes específicos do evento.

5

Seu callback retorna uma decisão

Após realizar qualquer operação (registro, chamadas de API, validação), seu callback retorna um objeto de saída que diz ao agente o que fazer: permitir a operação, bloqueá-la, modificar a entrada ou injetar contexto na conversa.

O exemplo a seguir reúne essas etapas. Ele registra um hook PreToolUse (etapa 1) com um matcher "Write|Edit" (etapa 3) para que o callback seja acionado apenas para ferramentas de escrita de arquivo. Quando acionado, o callback recebe a entrada da ferramenta (etapa 4), verifica se o caminho do arquivo tem como alvo um arquivo .env e retorna permissionDecision: "deny" para bloquear a operação (etapa 5):

import asyncio
from claude_agent_sdk import (
AssistantMessage,
ClaudeSDKClient,
ClaudeAgentOptions,
HookMatcher,
ResultMessage,
)


# Define a hook callback that receives tool call details
async def protect_env_files(input_data, tool_use_id, context):
# Extract the file path from the tool's input arguments
file_path = input_data["tool_input"].get("file_path", "")
file_name = file_path.split("/")[-1]

# Block the operation if targeting a .env file
if file_name == ".env":
return {
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "deny",
"permissionDecisionReason": "Cannot modify .env files",
}
}

# Return empty object to allow the operation
return {}


async def main():
options = ClaudeAgentOptions(
hooks={
# Register the hook for PreToolUse events
# The matcher filters to only Write and Edit tool calls
"PreToolUse": [HookMatcher(matcher="Write|Edit", hooks=[protect_env_files])]
}
)

async with ClaudeSDKClient(options=options) as client:
await client.query("Update the database configuration")
async for message in client.receive_response():
# Filter for assistant and result messages
if isinstance(message, (AssistantMessage, ResultMessage)):
print(message)


asyncio.run(main())

Hooks disponíveis

O SDK fornece hooks para diferentes estágios de execução do agente. Alguns hooks estão disponíveis em ambos os SDKs, enquanto outros são apenas para TypeScript.

Evento de Hook SDK Python SDK TypeScript O que o dispara Caso de uso de exemplo
PreToolUse Sim Sim Solicitação de chamada de ferramenta (pode bloquear ou modificar) Bloquear comandos shell perigosos
PostToolUse Sim Sim Resultado de execução de ferramenta Registrar todas as alterações de arquivo na trilha de auditoria
PostToolUseFailure Sim Sim Falha na execução de ferramenta Lidar ou registrar erros de ferramenta
PostToolBatch Não Sim Um lote completo de chamadas de ferramenta é resolvido, uma vez por lote antes da próxima chamada de modelo Injetar convenções uma vez para todo o lote
UserPromptSubmit Sim Sim Envio de prompt do usuário Injetar contexto adicional em prompts
Stop Sim Sim Parada de execução do agente Salvar estado da sessão antes de sair
SubagentStart Sim Sim Inicialização de subagente Rastrear geração de tarefas paralelas
SubagentStop Sim Sim Conclusão de subagente Agregar resultados de tarefas paralelas
PreCompact Sim Sim Solicitação de compactação de conversa Arquivar transcrição completa antes de resumir
PermissionRequest Sim Sim Diálogo de permissão seria exibido Manipulação de permissão personalizada
SessionStart Não Sim Inicialização de sessão Inicializar registro e telemetria
SessionEnd Não Sim Encerramento de sessão Limpar recursos temporários
Notification Sim Sim Mensagens de status do agente Enviar atualizações de status do agente para Slack ou PagerDuty
Setup Não Sim Configuração/manutenção de sessão Executar tarefas de inicialização
TeammateIdle Não Sim Colega fica ocioso Reatribuir trabalho ou notificar
TaskCompleted Não Sim Tarefa em segundo plano é concluída Agregar resultados de tarefas paralelas
ConfigChange Não Sim Arquivo de configuração muda Recarregar configurações dinamicamente
WorktreeCreate Não Sim Git worktree criado Rastrear espaços de trabalho isolados
WorktreeRemove Não Sim Git worktree removido Limpar recursos de espaço de trabalho

Configurar hooks

Para configurar um hook, passe-o no campo hooks de suas opções de agente (ClaudeAgentOptions em Python, o objeto options em TypeScript):

options = ClaudeAgentOptions(
hooks={"PreToolUse": [HookMatcher(matcher="Bash", hooks=[my_callback])]}
)

async with ClaudeSDKClient(options=options) as client:
await client.query("Your prompt")
async for message in client.receive_response():
print(message)

A opção hooks é um dicionário (Python) ou objeto (TypeScript) onde:

Matchers

Use matchers para filtrar quando seus callbacks são acionados. O campo matcher é uma string regex que corresponde a um valor diferente dependendo do tipo de evento de hook. Por exemplo, hooks baseados em ferramentas correspondem ao nome da ferramenta, enquanto hooks Notification correspondem ao tipo de notificação. Veja a referência de hooks do Claude Code para a lista completa de valores de matcher para cada tipo de evento.

Opção Tipo Padrão Descrição
matcher string undefined Padrão regex correspondido contra o campo de filtro do evento. Para hooks de ferramenta, este é o nome da ferramenta. As ferramentas integradas incluem Bash, Read, Write, Edit, Glob, Grep, WebFetch, Agent e outras (veja Tipos de Entrada de Ferramenta para a lista completa). Ferramentas MCP usam o padrão mcp__<server>__<action>.
hooks HookCallback[] - Obrigatório. Array de funções de callback a executar quando o padrão corresponde
timeout number 60 Timeout em segundos

Use o padrão matcher para direcionar ferramentas específicas sempre que possível. Um matcher com 'Bash' é executado apenas para comandos Bash, enquanto omitir o padrão executa seus callbacks para cada ocorrência do evento. Observe que para hooks baseados em ferramentas, matchers filtram apenas pelo nome da ferramenta, não por caminhos de arquivo ou outros argumentos. Para filtrar por caminho de arquivo, verifique tool_input.file_path dentro de seu callback.

Funções de callback

Entradas

Cada callback de hook recebe três argumentos:

  • Dados de entrada: um objeto tipado contendo detalhes do evento. Cada tipo de hook tem sua própria forma de entrada (por exemplo, PreToolUseHookInput inclui tool_name e tool_input, enquanto NotificationHookInput inclui message). Veja as definições de tipo completas nas referências do SDK TypeScript e Python.
    • Todas as entradas de hook compartilham session_id, cwd e hook_event_name.
    • agent_id e agent_type são preenchidos quando o hook é acionado dentro de um subagente. Em TypeScript, estes estão na entrada de hook base e disponíveis para todos os tipos de hook. Em Python, eles estão em PreToolUse, PostToolUse e PostToolUseFailure apenas.
  • ID de uso de ferramenta (str | None / string | undefined): correlaciona eventos PreToolUse e PostToolUse para a mesma chamada de ferramenta.
  • Contexto: em TypeScript, contém uma propriedade signal (AbortSignal) para cancelamento. Em Python, este argumento é reservado para uso futuro.

Saídas

Seu callback retorna um objeto com duas categorias de campos:

  • Campos de nível superior funcionam da mesma forma em cada evento: systemMessage mostra uma mensagem ao usuário, e continue (continue_ em Python) determina se o agente continua executando após este hook.
  • hookSpecificOutput controla a operação atual. Os campos dentro dependem do tipo de evento de hook. Para hooks PreToolUse, é aqui que você define permissionDecision ("allow", "deny", "ask" ou "defer"), permissionDecisionReason e updatedInput. Retornar "defer" encerra a consulta para que você possa retomá-la depois. Para hooks PostToolUse, você pode definir additionalContext para anexar informações ao resultado da ferramenta, ou updatedToolOutput para substituir completamente a saída da ferramenta antes de Claude vê-la.

Retorne {} para permitir a operação sem alterações. Hooks de callback do SDK usam o mesmo formato de saída JSON que hooks de comando shell do Claude Code, que documenta cada campo e opção específica do evento. Para as definições de tipo do SDK, veja as referências do SDK TypeScript e Python.

Saída assíncrona

Por padrão, o agente aguarda seu hook retornar antes de prosseguir. Se seu hook realiza um efeito colateral (registro, envio de webhook) e não precisa influenciar o comportamento do agente, você pode retornar uma saída assíncrona. Isso diz ao agente para continuar imediatamente sem aguardar o hook terminar:

async def async_hook(input_data, tool_use_id, context):
# Start a background task, then return immediately
asyncio.create_task(send_to_logging_service(input_data))
return {"async_": True, "asyncTimeout": 30000}
Campo Tipo Descrição
async true Sinaliza modo assíncrono. O agente prossegue sem aguardar. Em Python, use async_ para evitar a palavra-chave reservada.
asyncTimeout number Timeout opcional em milissegundos para a operação em segundo plano

Exemplos

Modificar entrada de ferramenta

Este exemplo intercepta chamadas de ferramenta Write e reescreve o argumento file_path para prepender /sandbox, redirecionando todas as gravações de arquivo para um diretório em sandbox. O callback retorna updatedInput com o caminho modificado e permissionDecision: 'allow' para aprovar automaticamente a operação reescrita:

async def redirect_to_sandbox(input_data, tool_use_id, context):
if input_data["hook_event_name"] != "PreToolUse":
return {}

if input_data["tool_name"] == "Write":
original_path = input_data["tool_input"].get("file_path", "")
return {
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "allow",
"updatedInput": {
**input_data["tool_input"],
"file_path": f"/sandbox{original_path}",
},
}
}
return {}

Adicionar contexto e bloquear uma ferramenta

Este exemplo bloqueia gravações no diretório /etc e explica o motivo tanto para o modelo quanto para o usuário:

  • permissionDecision: 'deny' interrompe a chamada de ferramenta.
  • permissionDecisionReason informa ao modelo por que, para que ele evite tentar novamente.
  • systemMessage mostra ao usuário o que aconteceu.
async def block_etc_writes(input_data, tool_use_id, context):
file_path = input_data["tool_input"].get("file_path", "")

if file_path.startswith("/etc"):
return {
# Top-level field: message shown to the user
"systemMessage": "Remember: system directories like /etc are protected.",
# hookSpecificOutput: block the operation
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "deny",
"permissionDecisionReason": "Writing to /etc is not allowed",
},
}
return {}

Aprovar automaticamente ferramentas específicas

Por padrão, o agente pode solicitar permissão antes de usar certas ferramentas. Este exemplo aprova automaticamente ferramentas de sistema de arquivos somente leitura (Read, Glob, Grep) retornando permissionDecision: 'allow', permitindo que sejam executadas sem confirmação do usuário enquanto deixa todas as outras ferramentas sujeitas a verificações de permissão normais:

async def auto_approve_read_only(input_data, tool_use_id, context):
if input_data["hook_event_name"] != "PreToolUse":
return {}

read_only_tools = ["Read", "Glob", "Grep"]
if input_data["tool_name"] in read_only_tools:
return {
"hookSpecificOutput": {
"hookEventName": input_data["hook_event_name"],
"permissionDecision": "allow",
"permissionDecisionReason": "Read-only tool auto-approved",
}
}
return {}

Registrar múltiplos hooks

Quando um evento é disparado, todos os hooks correspondentes são executados em paralelo. Para decisões de permissão, o resultado mais restritivo vence: um único deny bloqueia a chamada de ferramenta independentemente do que os outros hooks retornam. Como a ordem de conclusão é não-determinística, escreva cada hook para agir independentemente em vez de depender de outro hook ter sido executado primeiro.

O exemplo abaixo registra três verificações independentes para cada chamada de ferramenta:

options = ClaudeAgentOptions(
hooks={
"PreToolUse": [
HookMatcher(hooks=[authorization_check]),
HookMatcher(hooks=[input_validator]),
HookMatcher(hooks=[audit_logger]),
]
}
)

Filtrar com matchers regex

Use padrões regex para corresponder múltiplas ferramentas. Este exemplo registra três matchers com escopos diferentes: o primeiro dispara file_security_hook apenas para ferramentas de modificação de arquivo, o segundo dispara mcp_audit_hook para qualquer ferramenta MCP (ferramentas cujos nomes começam com mcp__), e o terceiro dispara global_logger para cada chamada de ferramenta independentemente do nome:

options = ClaudeAgentOptions(
hooks={
"PreToolUse": [
# Match file modification tools
HookMatcher(matcher="Write|Edit|Delete", hooks=[file_security_hook]),
# Match all MCP tools
HookMatcher(matcher="^mcp__", hooks=[mcp_audit_hook]),
# Match everything (no matcher)
HookMatcher(hooks=[global_logger]),
]
}
)

Rastrear atividade de subagente

Use hooks SubagentStop para monitorar quando subagentes terminam seu trabalho. Veja o tipo de entrada completo nas referências do SDK TypeScript e Python. Este exemplo registra um resumo cada vez que um subagente é concluído:

async def subagent_tracker(input_data, tool_use_id, context):
# Log subagent details when it finishes
print(f"[SUBAGENT] Completed: {input_data['agent_id']}")
print(f"  Transcript: {input_data['agent_transcript_path']}")
print(f"  Tool use ID: {tool_use_id}")
print(f"  Stop hook active: {input_data.get('stop_hook_active')}")
return {}


options = ClaudeAgentOptions(
hooks={"SubagentStop": [HookMatcher(hooks=[subagent_tracker])]}
)

Fazer requisições HTTP a partir de hooks

Hooks podem realizar operações assíncronas como requisições HTTP. Capture erros dentro de seu hook em vez de deixá-los se propagar, pois uma exceção não tratada pode interromper o agente.

Este exemplo envia um webhook após cada ferramenta ser concluída, registrando qual ferramenta foi executada e quando. O hook captura erros para que um webhook falhado não interrompa o agente:

import asyncio
import json
import urllib.request
from datetime import datetime


def _send_webhook(tool_name):
"""Synchronous helper that POSTs tool usage data to an external webhook."""
data = json.dumps(
{
"tool": tool_name,
"timestamp": datetime.now().isoformat(),
}
).encode()
req = urllib.request.Request(
"https://api.example.com/webhook",
data=data,
headers={"Content-Type": "application/json"},
method="POST",
)
urllib.request.urlopen(req)


async def webhook_notifier(input_data, tool_use_id, context):
# Only fire after a tool completes (PostToolUse), not before
if input_data["hook_event_name"] != "PostToolUse":
return {}

try:
# Run the blocking HTTP call in a thread to avoid blocking the event loop
await asyncio.to_thread(_send_webhook, input_data["tool_name"])
except Exception as e:
# Log the error but don't raise. A failed webhook shouldn't stop the agent
print(f"Webhook request failed: {e}")

return {}

Encaminhar notificações para Slack

Use hooks Notification para receber notificações do sistema do agente e encaminhá-las para serviços externos. Notificações são disparadas para tipos de evento específicos: permission_prompt (Claude precisa de permissão), idle_prompt (Claude está aguardando entrada), auth_success (autenticação concluída), elicitation_dialog (Claude está solicitando ao usuário), elicitation_response (o usuário respondeu a uma elicitação) e elicitation_complete (uma elicitação foi fechada). Cada notificação inclui um campo message com uma descrição legível por humanos e opcionalmente um title.

Este exemplo encaminha cada notificação para um canal Slack. Requer uma URL de webhook de entrada do Slack, que você cria adicionando um app ao seu espaço de trabalho Slack e habilitando webhooks de entrada:

import asyncio
import json
import urllib.request

from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, HookMatcher


def _send_slack_notification(message):
"""Synchronous helper that sends a message to Slack via incoming webhook."""
data = json.dumps({"text": f"Agent status: {message}"}).encode()
req = urllib.request.Request(
"https://hooks.slack.com/services/YOUR/WEBHOOK/URL",
data=data,
headers={"Content-Type": "application/json"},
method="POST",
)
urllib.request.urlopen(req)


async def notification_handler(input_data, tool_use_id, context):
try:
# Run the blocking HTTP call in a thread to avoid blocking the event loop
await asyncio.to_thread(_send_slack_notification, input_data.get("message", ""))
except Exception as e:
print(f"Failed to send notification: {e}")

# Return empty object. Notification hooks don't modify agent behavior
return {}


async def main():
options = ClaudeAgentOptions(
hooks={
# Register the hook for Notification events (no matcher needed)
"Notification": [HookMatcher(hooks=[notification_handler])],
},
)

async with ClaudeSDKClient(options=options) as client:
await client.query("Analyze this codebase")
async for message in client.receive_response():
print(message)


asyncio.run(main())

Corrigir problemas comuns

Hook não é disparado

  • Verifique se o nome do evento de hook está correto e sensível a maiúsculas/minúsculas (PreToolUse, não preToolUse)
  • Verifique se seu padrão de matcher corresponde exatamente ao nome da ferramenta
  • Certifique-se de que o hook está sob o tipo de evento correto em options.hooks
  • Para hooks não baseados em ferramentas como Stop e SubagentStop, matchers correspondem a campos diferentes (veja padrões de matcher)
  • Hooks podem não ser disparados quando o agente atinge o limite max_turns porque a sessão termina antes que hooks possam ser executados

Matcher não filtra como esperado

Matchers apenas correspondem a nomes de ferramentas, não a caminhos de arquivo ou outros argumentos. Para filtrar por caminho de arquivo, verifique tool_input.file_path dentro de seu hook:

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

Timeout de hook

  • Aumente o valor timeout na configuração HookMatcher
  • Use o AbortSignal do terceiro argumento de callback para lidar com cancelamento graciosamente em TypeScript

Ferramenta bloqueada inesperadamente

  • Verifique todos os hooks PreToolUse para retornos permissionDecision: 'deny'
  • Adicione registro aos seus hooks para ver qual permissionDecisionReason eles estão retornando
  • Verifique se padrões de matcher não são muito amplos (um matcher vazio corresponde a todas as ferramentas)

Entrada modificada não aplicada

  • Certifique-se de que updatedInput está dentro de hookSpecificOutput, não no nível superior:

    return {
      hookSpecificOutput: {
        hookEventName: "PreToolUse",
        permissionDecision: "allow",
        updatedInput: { command: "new command" }
      }
    };
    
  • Você também deve retornar permissionDecision: 'allow' ou 'ask' para que a modificação de entrada tenha efeito

  • Inclua hookEventName em hookSpecificOutput para identificar qual tipo de hook a saída é

Hooks de sessão não disponíveis em Python

SessionStart e SessionEnd podem ser registrados como hooks de callback do SDK em TypeScript, mas não estão disponíveis no SDK Python (HookEvent os omite). Em Python, eles estão disponíveis apenas como hooks de comando shell definidos em arquivos de configuração (por exemplo, .claude/settings.json). Para carregar hooks de comando shell de sua aplicação SDK, inclua a fonte de configuração apropriada com setting_sources ou settingSources:

options = ClaudeAgentOptions(
setting_sources=["project"],  # Loads .claude/settings.json including hooks
)

Para executar lógica de inicialização como um callback do SDK Python, use a primeira mensagem de client.receive_response() como seu gatilho.

Prompts de permissão de subagente se multiplicando

Ao gerar múltiplos subagentes, cada um pode solicitar permissões separadamente. Subagentes não herdam automaticamente permissões do agente pai. Para evitar prompts repetidos, use hooks PreToolUse para aprovar automaticamente ferramentas específicas ou configure regras de permissão que se aplicam a sessões de subagente.

Loops recursivos de hook com subagentes

Um hook UserPromptSubmit que gera subagentes pode criar loops infinitos se esses subagentes acionarem o mesmo hook. Para evitar isso:

  • Verifique um indicador de subagente na entrada do hook antes de gerar
  • Use uma variável compartilhada ou estado de sessão para rastrear se você já está dentro de um subagente
  • Escopo hooks para executar apenas para a sessão de agente de nível superior

systemMessage não aparecendo na saída

O campo systemMessage mostra uma mensagem ao usuário, não ao modelo. Por padrão, o SDK não expõe a saída de hook no fluxo de mensagens, portanto a mensagem pode não aparecer a menos que você defina includeHookEvents (include_hook_events em Python). Para passar contexto ao modelo, retorne additionalContext.

Se você precisar expor decisões de hook para sua aplicação de forma confiável, registre-as separadamente ou use um canal de saída dedicado.

Recursos relacionados