- Gefährliche Operationen blockieren, bevor sie ausgeführt werden, z. B. destruktive Shell-Befehle oder nicht autorisierter Dateizugriff
- Alle Tool-Aufrufe protokollieren und überprüfen für Compliance, Debugging oder Analytik
- Eingaben und Ausgaben transformieren, um Daten zu bereinigen, Anmeldedaten einzufügen oder Dateipfade umzuleiten
- Menschliche Genehmigung anfordern für sensible Aktionen wie Datenbankschreibvorgänge oder API-Aufrufe
- Sitzungslebenszyklus verfolgen, um den Status zu verwalten, Ressourcen freizugeben oder Benachrichtigungen zu senden
Funktionsweise von Hooks
Ein Ereignis wird ausgelöst
Während der Agent-Ausführung passiert etwas und das SDK löst ein Ereignis aus: Ein Tool wird aufgerufen (
PreToolUse), ein Tool gibt ein Ergebnis zurück (PostToolUse), ein Subagent startet oder stoppt, der Agent ist untätig oder die Ausführung ist beendet. Siehe die vollständige Liste der Ereignisse.Das SDK sammelt registrierte Hooks
Das SDK prüft auf Hooks, die für diesen Ereignistyp registriert sind. Dies umfasst Callback-Hooks, die Sie in
options.hooks übergeben, und Shell-Befehls-Hooks aus Einstellungsdateien, wenn der entsprechende settingSources oder setting_sources Eintrag aktiviert ist, was für Standard-query()-Optionen der Fall ist.Matcher filtern, welche Hooks ausgeführt werden
Wenn ein Hook ein
matcher Muster hat (z. B. "Write|Edit"), testet das SDK es gegen das Ziel des Ereignisses (z. B. den Tool-Namen). Hooks ohne Matcher werden für jedes Ereignis dieses Typs ausgeführt.Callback-Funktionen werden ausgeführt
Jede übereinstimmende Hook-Callback-Funktion erhält Eingaben über das, was passiert: den Tool-Namen, seine Argumente, die Sitzungs-ID und andere ereignisspezifische Details.
Ihr Callback gibt eine Entscheidung zurück
Nach dem Ausführen von Operationen (Protokollierung, API-Aufrufe, Validierung) gibt Ihr Callback ein Ausgabeobjekt zurück, das dem Agent mitteilt, was zu tun ist: die Operation zulassen, blockieren, die Eingabe ändern oder Kontext in das Gespräch einfügen.
PreToolUse Hook (Schritt 1) mit einem "Write|Edit" Matcher (Schritt 3), sodass der Callback nur für Datei-Schreib-Tools ausgelöst wird. Wenn ausgelöst, erhält der Callback die Eingabe des Tools (Schritt 4), prüft, ob der Dateipfad auf eine .env-Datei abzielt, und gibt permissionDecision: "deny" zurück, um die Operation zu blockieren (Schritt 5):
Verfügbare Hooks
Das SDK bietet Hooks für verschiedene Phasen der Agent-Ausführung. Einige Hooks sind in beiden SDKs verfügbar, während andere nur für TypeScript verfügbar sind.| Hook-Ereignis | Python SDK | TypeScript SDK | Was löst es aus | Beispiel-Anwendungsfall |
|---|---|---|---|---|
PreToolUse | Ja | Ja | Tool-Aufrufanforderung (kann blockiert oder geändert werden) | Gefährliche Shell-Befehle blockieren |
PostToolUse | Ja | Ja | Tool-Ausführungsergebnis | Alle Dateiänderungen im Audit-Trail protokollieren |
PostToolUseFailure | Ja | Ja | Tool-Ausführungsfehler | Tool-Fehler behandeln oder protokollieren |
PostToolBatch | Nein | Ja | Ein vollständiger Batch von Tool-Aufrufen wird aufgelöst, einmal pro Batch vor dem nächsten Modellaufruf | Konventionen einmal für den gesamten Batch einfügen |
UserPromptSubmit | Ja | Ja | Benutzer-Prompt-Übermittlung | Zusätzlichen Kontext in Prompts einfügen |
MessageDisplay | Nein | Ja | Eine Assistenten-Nachricht mit Text wird abgeschlossen, einmal pro Nachricht mit dem vollständigen Nachrichtentext | Angezeigten Text redigieren oder neu formatieren, ohne das Transkript zu ändern |
Stop | Ja | Ja | Agent-Ausführung stoppt | Sitzungsstatus vor dem Beenden speichern |
SubagentStart | Ja | Ja | Subagent-Initialisierung | Parallele Task-Spawning verfolgen |
SubagentStop | Ja | Ja | Subagent-Fertigstellung | Ergebnisse aus parallelen Tasks aggregieren |
PreCompact | Ja | Ja | Anforderung zur Gesprächskomprimierung | Vollständiges Transkript vor der Zusammenfassung archivieren |
PermissionRequest | Ja | Ja | Berechtigungsdialog würde angezeigt | Benutzerdefinierte Berechtigungsbehandlung |
SessionStart | Nein | Ja | Sitzungsinitialisierung | Protokollierung und Telemetrie initialisieren |
SessionEnd | Nein | Ja | Sitzungsbeendigung | Temporäre Ressourcen bereinigen |
Notification | Ja | Ja | Agent-Statusmeldungen | Agent-Status-Updates an Slack oder PagerDuty senden |
Setup | Nein | Ja | Sitzungssetup/Wartung | Initialisierungsaufgaben ausführen |
TeammateIdle | Nein | Ja | Teammate wird untätig | Arbeit neu zuweisen oder benachrichtigen |
TaskCompleted | Nein | Ja | Hintergrund-Task wird abgeschlossen | Ergebnisse aus parallelen Tasks aggregieren |
ConfigChange | Nein | Ja | Konfigurationsdatei ändert sich | Einstellungen dynamisch neu laden |
WorktreeCreate | Nein | Ja | Git Worktree erstellt | Isolierte Workspaces verfolgen |
WorktreeRemove | Nein | Ja | Git Worktree entfernt | Workspace-Ressourcen bereinigen |
Hooks konfigurieren
Um einen Hook zu konfigurieren, übergeben Sie ihn imhooks Feld Ihrer Agent-Optionen (ClaudeAgentOptions in Python, das options Objekt in TypeScript):
hooks Option ist ein Wörterbuch (Python) oder Objekt (TypeScript), wobei:
- Schlüssel Hook-Ereignisnamen sind (z. B.
'PreToolUse','PostToolUse','Stop') - Werte Arrays von Matchern sind, die jeweils ein optionales Filtermuster und Ihre Callback-Funktionen enthalten
Matcher
Verwenden Sie Matcher, um zu filtern, wann Ihre Callbacks ausgelöst werden. Dasmatcher Feld wird gegen einen anderen Wert abgeglichen, je nach Hook-Ereignistyp. Beispielsweise werden Tool-basierte Hooks gegen den Tool-Namen abgeglichen, während Notification Hooks gegen den Benachrichtigungstyp abgeglichen werden. Siehe die Claude Code Hooks-Referenz für die vollständige Liste der Matcher-Werte für jeden Ereignistyp.
SDK-Matcher folgen den gleichen Regeln wie Matcher in Einstellungsdateien: Ein Matcher, der nur Buchstaben, Ziffern, _ und | enthält, wird als exakte Zeichenkette verglichen, wobei | Alternativen trennt, also Write|Edit passt genau auf diese beiden Tools. Ein Matcher von *, eine leere Zeichenkette oder das Weglassen des Matchers ganz passt auf jedes Vorkommen des Ereignisses; ein Matcher, der ein anderes Zeichen enthält, wird als regulärer Ausdruck ausgewertet, also ^mcp__ passt auf jedes MCP-Tool. Ein Matcher wie mcp__memory enthält nur Buchstaben und Unterstriche, wird also als exakte Zeichenkette verglichen und passt auf kein Tool; verwenden Sie mcp__memory__.*, um auf jedes Tool von diesem Server zu passen.
| Option | Typ | Standard | Beschreibung |
|---|---|---|---|
matcher | string | undefined | Muster, das gegen das Filterfeld des Ereignisses abgeglichen wird, nach den obigen Vergleichsregeln. Für Tool-Hooks ist dies der Tool-Name. Integrierte Tools umfassen Bash, Read, Write, Edit, Glob, Grep, WebFetch, Agent und andere (siehe Tool-Eingabetypen für die vollständige Liste). MCP-Tools verwenden das Muster mcp__<server>__<action>. |
hooks | HookCallback[] | - | Erforderlich. Array von Callback-Funktionen, die ausgeführt werden, wenn das Muster übereinstimmt |
timeout | number | 60 | Timeout in Sekunden |
matcher Muster, um nach Möglichkeit spezifische Tools anzusteuern. Ein Matcher mit 'Bash' wird nur für Bash-Befehle ausgeführt, während das Weglassen des Musters Ihre Callbacks für jedes Vorkommen des Ereignisses ausführt. Beachten Sie, dass für Tool-basierte Hooks Matcher nur nach Tool-Namen filtern, nicht nach Dateipfaden oder anderen Argumenten. Um nach Dateipfad zu filtern, prüfen Sie tool_input.file_path in Ihrem Callback.
Callback-Funktionen
Eingaben
Jeder Hook-Callback erhält drei Argumente:- Eingabedaten: ein typisiertes Objekt mit Ereignisdetails. Jeder Hook-Typ hat seine eigene Eingabeform (beispielsweise enthält
PreToolUseHookInputtool_nameundtool_input, währendNotificationHookInputmessageenthält). Siehe die vollständigen Typdefinitionen in den TypeScript und Python SDK-Referenzen.- Alle Hook-Eingaben teilen
session_id,cwdundhook_event_name. agent_idundagent_typewerden ausgefüllt, wenn der Hook in einem Subagent ausgelöst wird. In TypeScript befinden sich diese in der Basis-Hook-Eingabe und sind für alle Hook-Typen verfügbar. In Python sind sie nur aufPreToolUse,PostToolUseundPostToolUseFailurevorhanden.
- Alle Hook-Eingaben teilen
- Tool-Verwendungs-ID (
str | None/string | undefined): korreliertPreToolUseundPostToolUseEreignisse für denselben Tool-Aufruf. - Kontext: In TypeScript enthält eine
signalEigenschaft (AbortSignal) für Abbruch. In Python ist dieses Argument für zukünftige Verwendung reserviert.
Ausgaben
Ihr Callback gibt ein Objekt mit zwei Kategorien von Feldern zurück:- Top-Level-Felder funktionieren bei jedem Ereignis gleich:
systemMessagezeigt eine Nachricht für den Benutzer an, undcontinue(continue_in Python) bestimmt, ob der Agent nach diesem Hook weiterläuft. hookSpecificOutputsteuert die aktuelle Operation. Die Felder darin hängen vom Hook-Ereignistyp ab. FürPreToolUseHooks ist dies der Ort, an dem SiepermissionDecision("allow","deny","ask"oder"defer"),permissionDecisionReasonundupdatedInputsetzen. Wenn Sie"defer"zurückgeben, endet die Abfrage, damit Sie sie später fortsetzen können. FürPostToolUseHooks können SieadditionalContextsetzen, um Informationen zum Tool-Ergebnis anzuhängen. Um die Ausgabe des Tools vor Claude zu ersetzen, setzen SieupdatedToolOutput, das für jedes Tool in beiden SDKs funktioniert. Das ältereupdatedMCPToolOutputFeld ersetzt nur MCP-Tool-Ausgabe und ist veraltet.
{} zurück, um die Operation ohne Änderungen zuzulassen. SDK-Callback-Hooks verwenden das gleiche JSON-Ausgabeformat wie Claude Code Shell-Befehls-Hooks, das jedes Feld und ereignisspezifische Option dokumentiert. Für die SDK-Typdefinitionen siehe die TypeScript und Python SDK-Referenzen.
Wenn mehrere Hooks oder Berechtigungsregeln gelten, hat deny Vorrang vor defer, was Vorrang vor ask hat, was Vorrang vor allow hat. Wenn ein Hook
deny zurückgibt, wird die Operation blockiert, unabhängig von anderen Hooks.Asynchrone Ausgabe
Standardmäßig wartet der Agent darauf, dass Ihr Hook zurückkommt, bevor er fortfährt. Wenn Ihr Hook einen Nebeneffekt ausführt (Protokollierung, Webhook-Versand) und das Verhalten des Agenten nicht beeinflussen muss, können Sie stattdessen eine asynchrone Ausgabe zurückgeben. Dies teilt dem Agent mit, dass er sofort fortfahren soll, ohne auf die Fertigstellung des Hooks zu warten:| Feld | Typ | Beschreibung |
|---|---|---|
async | true | Signalisiert Async-Modus. Der Agent fährt fort, ohne zu warten. In Python verwenden Sie async_, um das reservierte Schlüsselwort zu vermeiden. |
asyncTimeout | number | Optionales Timeout in Millisekunden für die Hintergrund-Operation |
Asynchrone Ausgaben können nicht blockieren, ändern oder Kontext in die Operation einfügen, da der Agent bereits weitergegangen ist. Verwenden Sie sie nur für Nebeneffekte wie Protokollierung, Metriken oder Benachrichtigungen.
Beispiele
Tool-Eingabe ändern
Dieses Beispiel fängt Write-Tool-Aufrufe ab und schreibt dasfile_path Argument um, um /sandbox voranzustellen, wodurch alle Datei-Schreibvorgänge in ein Sandbox-Verzeichnis umgeleitet werden. Der Callback gibt updatedInput mit dem geänderten Pfad und permissionDecision: 'allow' zurück, um die umgeschriebene Operation automatisch zu genehmigen:
Wenn Sie
updatedInput verwenden, müssen Sie auch permissionDecision: 'allow' einschließen, um die geänderte Eingabe automatisch zu genehmigen, oder permissionDecision: 'ask', um sie dem Benutzer anzuzeigen. Mit 'defer' wird updatedInput ignoriert. Geben Sie immer ein neues Objekt zurück, anstatt das ursprüngliche tool_input zu mutieren.Kontext hinzufügen und ein Tool blockieren
Dieses Beispiel blockiert Schreibvorgänge in das/etc Verzeichnis und erklärt den Grund sowohl dem Modell als auch dem Benutzer:
permissionDecision: 'deny'stoppt den Tool-Aufruf.permissionDecisionReasonteilt dem Modell mit, warum, damit es nicht erneut versucht.systemMessagezeigt dem Benutzer, was passiert ist.
Spezifische Tools automatisch genehmigen
Standardmäßig kann der Agent vor der Verwendung bestimmter Tools um Genehmigung bitten. Dieses Beispiel genehmigt schreibgeschützte Dateisystem-Tools (Read, Glob, Grep) automatisch, indempermissionDecision: 'allow' zurückgegeben wird, sodass sie ohne Benutzerbestätigung ausgeführt werden, während alle anderen Tools normalen Berechtigungsprüfungen unterliegen:
Mehrere Hooks registrieren
Wenn ein Ereignis ausgelöst wird, werden alle übereinstimmenden Hooks parallel ausgeführt. Bei Berechtigungsentscheidungen gewinnt das restriktivste Ergebnis: Ein einzelnesdeny blockiert den Tool-Aufruf, unabhängig davon, was die anderen Hooks zurückgeben. Da die Abschlussreihenfolge nicht deterministisch ist, schreiben Sie jeden Hook so, dass er unabhängig agiert, anstatt sich darauf zu verlassen, dass ein anderer Hook zuerst ausgeführt wurde.
Das folgende Beispiel registriert drei unabhängige Prüfungen für jeden Tool-Aufruf:
Mit Multi-Tool-Matchern filtern
Verwenden Sie Multi-Tool-Matcher, um einen Callback über verwandte Tools hinweg zu teilen. Dieses Beispiel registriert drei Matcher mit unterschiedlichen Bereichen:- Eine durch Pipe getrennte exakte Liste (
Write|Edit|Delete) löstfile_security_hooknur für Datei-Änderungs-Tools aus. - Ein Regex (
^mcp__) löstmcp_audit_hookfür alle MCP-Tools aus, deren Namen mitmcp__beginnen. - Ein weggelassener Matcher löst
global_loggerfür jeden Tool-Aufruf unabhängig vom Namen aus.
Subagent-Aktivität verfolgen
Verwenden SieSubagentStop Hooks, um zu überwachen, wenn Subagents ihre Arbeit beenden. Siehe den vollständigen Eingabetyp in den TypeScript und Python SDK-Referenzen. Dieses Beispiel protokolliert eine Zusammenfassung jedes Mal, wenn ein Subagent abgeschlossen wird:
HTTP-Anfragen von Hooks aus stellen
Hooks können asynchrone Operationen wie HTTP-Anfragen ausführen. Fangen Sie Fehler in Ihrem Hook ab, anstatt sie zu propagieren, da eine nicht behandelte Ausnahme den Agent unterbrechen kann. Dieses Beispiel sendet einen Webhook nach jeder Tool-Fertigstellung und protokolliert, welches Tool ausgeführt wurde und wann. Der Hook fängt Fehler ab, sodass ein fehlgeschlagener Webhook den Agent nicht unterbricht:Benachrichtigungen an Slack weiterleiten
Verwenden SieNotification Hooks, um Systembenachrichtigungen vom Agent zu empfangen und sie an externe Dienste weiterzuleiten. Benachrichtigungen werden für Ereignistypen wie folgt ausgelöst:
permission_promptwenn Claude Genehmigung benötigtidle_promptwenn Claude auf Eingabe wartetauth_successwenn Authentifizierung abgeschlossen istelicitation_dialog,elicitation_completeundelicitation_responsefür Benutzer-Abfrage-Flows
message Feld mit einer für Menschen lesbaren Beschreibung und optional einen title.
Dieses Beispiel leitet jede Benachrichtigung an einen Slack-Kanal weiter. Es erfordert eine Slack Incoming Webhook URL, die Sie erstellen, indem Sie eine App zu Ihrem Slack-Workspace hinzufügen und Incoming Webhooks aktivieren:
Häufige Probleme beheben
Hook wird nicht ausgelöst
- Überprüfen Sie, ob der Hook-Ereignisname korrekt und case-sensitiv ist (
PreToolUse, nichtpreToolUse) - Überprüfen Sie, ob Ihr Matcher-Muster den Tool-Namen genau abgleicht
- Stellen Sie sicher, dass der Hook unter dem richtigen Ereignistyp in
options.hooksist - Für Nicht-Tool-Hooks wie
StopundSubagentStopgleichen Matcher gegen verschiedene Felder ab (siehe Matcher-Muster) - Hooks werden möglicherweise nicht ausgelöst, wenn der Agent das
max_turnsLimit erreicht, da die Sitzung endet, bevor Hooks ausgeführt werden können
Matcher filtert nicht wie erwartet
Matcher gleichen nur Tool-Namen ab, nicht Dateipfade oder andere Argumente. Um nach Dateipfad zu filtern, prüfen Sietool_input.file_path in Ihrem Hook:
Hook-Timeout
- Erhöhen Sie den
timeoutWert in derHookMatcherKonfiguration - Verwenden Sie das
AbortSignalaus dem dritten Callback-Argument, um Abbruch elegant in TypeScript zu behandeln
Tool wird unerwartet blockiert
- Überprüfen Sie alle
PreToolUseHooks aufpermissionDecision: 'deny'Rückgaben - Fügen Sie Protokollierung zu Ihren Hooks hinzu, um zu sehen, welche
permissionDecisionReasonsie zurückgeben - Überprüfen Sie, ob Matcher-Muster nicht zu breit sind (ein leerer Matcher gleicht alle Tools ab)
Geänderte Eingabe wird nicht angewendet
-
Stellen Sie sicher, dass
updatedInputinhookSpecificOutputist, nicht auf der obersten Ebene: -
Geben Sie
permissionDecision: 'allow'zurück, um die geänderte Eingabe automatisch zu genehmigen, oder'ask', um sie dem Benutzer zur Genehmigung anzuzeigen -
Schließen Sie
hookEventNameinhookSpecificOutputein, um zu identifizieren, für welchen Hook-Typ die Ausgabe bestimmt ist
Sitzungs-Hooks nicht in Python verfügbar
SessionStart und SessionEnd können als SDK-Callback-Hooks in TypeScript registriert werden, sind aber im Python SDK nicht verfügbar (HookEvent lässt sie weg). In Python sind sie nur als Shell-Befehls-Hooks verfügbar, die in Einstellungsdateien definiert sind (z. B. .claude/settings.json). Um Shell-Befehls-Hooks aus Ihrer SDK-Anwendung zu laden, schließen Sie die entsprechende Einstellungsquelle mit setting_sources oder settingSources ein:
client.receive_response() als Auslöser.
Subagent-Berechtigungsaufforderungen vervielfachen sich
Beim Spawnen mehrerer Subagents kann jeder einzelne Berechtigungen separat anfordern. Subagents erben nicht automatisch Berechtigungen des übergeordneten Agenten. Um wiederholte Aufforderungen zu vermeiden, verwenden SiePreToolUse Hooks, um spezifische Tools automatisch zu genehmigen, oder konfigurieren Sie Berechtigungsregeln, die für Subagent-Sitzungen gelten.
Rekursive Hook-Schleifen mit Subagents
EinUserPromptSubmit Hook, der Subagents spawnt, kann unendliche Schleifen erzeugen, wenn diese Subagents denselben Hook auslösen. Um dies zu verhindern:
- Überprüfen Sie auf einen Subagent-Indikator in der Hook-Eingabe, bevor Sie spawnen
- Verwenden Sie eine gemeinsame Variable oder Sitzungsstatus, um zu verfolgen, ob Sie bereits in einem Subagent sind
- Beschränken Sie Hooks so, dass sie nur für die Top-Level-Agent-Sitzung ausgeführt werden
systemMessage wird nicht in der Ausgabe angezeigt
DassystemMessage Feld zeigt eine Nachricht für den Benutzer an, nicht für das Modell. Standardmäßig gibt das SDK Hook-Ausgaben nicht im Nachrichtenstrom aus, daher wird die Nachricht möglicherweise nicht angezeigt, es sei denn, Sie setzen includeHookEvents (include_hook_events in Python). Um stattdessen Kontext an das Modell zu übergeben, geben Sie additionalContext zurück.
Wenn Sie Hook-Entscheidungen für Ihre Anwendung zuverlässig sichtbar machen müssen, protokollieren Sie sie separat oder verwenden Sie einen dedizierten Ausgabekanal.
Verwandte Ressourcen
- Claude Code Hooks-Referenz: vollständige JSON-Eingabe-/Ausgabeschemas, Ereignisdokumentation und Matcher-Muster
- Claude Code Hooks-Leitfaden: Shell-Befehls-Hook-Beispiele und Walkthroughs
- TypeScript SDK-Referenz: Hook-Typen, Eingabe-/Ausgabedefinitionen und Konfigurationsoptionen
- Python SDK-Referenz: Hook-Typen, Eingabe-/Ausgabedefinitionen und Konfigurationsoptionen
- Berechtigungen: Steuern Sie, was Ihr Agent tun kann
- Benutzerdefinierte Tools: Erstellen Sie Tools, um Agent-Funktionen zu erweitern