1> ## Documentation Index
2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
3> Use this file to discover all available pages before exploring further.
4
5# Agent SDK Referenz - Python
6
7> Vollständige API-Referenz für das Python Agent SDK, einschließlich aller Funktionen, Typen und Klassen.
8
9## Installation
10
11```bash theme={null}
12pip install claude-agent-sdk
13```
14
15## Wahl zwischen `query()` und `ClaudeSDKClient`
16
17Das Python SDK bietet zwei Möglichkeiten, um mit Claude Code zu interagieren:
18
19### Schnellvergleich
20
21| Funktion | `query()` | `ClaudeSDKClient` |
22| :--------------------------- | :----------------------------------- | :------------------------------------- |
23| **Sitzung** | Erstellt jedes Mal eine neue Sitzung | Verwendet dieselbe Sitzung erneut |
24| **Konversation** | Einzelner Austausch | Mehrere Austausche im gleichen Kontext |
25| **Verbindung** | Automatisch verwaltet | Manuelle Kontrolle |
26| **Streaming-Eingabe** | ✅ Unterstützt | ✅ Unterstützt |
27| **Unterbrechungen** | ❌ Nicht unterstützt | ✅ Unterstützt |
28| **Hooks** | ✅ Unterstützt | ✅ Unterstützt |
29| **Benutzerdefinierte Tools** | ✅ Unterstützt | ✅ Unterstützt |
30| **Konversation fortsetzen** | ❌ Neue Sitzung jedes Mal | ✅ Behält Konversation bei |
31| **Anwendungsfall** | Einmalige Aufgaben | Kontinuierliche Konversationen |
32
33### Wann `query()` verwendet werden sollte (neue Sitzung jedes Mal)
34
35**Am besten für:**
36
37* Einmalige Fragen, bei denen Sie keinen Konversationsverlauf benötigen
38* Unabhängige Aufgaben, die keinen Kontext aus vorherigen Austauschen erfordern
39* Einfache Automatisierungsskripte
40* Wenn Sie jedes Mal einen neuen Anfang möchten
41
42### Wann `ClaudeSDKClient` verwendet werden sollte (kontinuierliche Konversation)
43
44**Am besten für:**
45
46* **Konversationen fortsetzen** - Wenn Claude den Kontext merken muss
47* **Nachfolgefragen** - Aufbauend auf vorherigen Antworten
48* **Interaktive Anwendungen** - Chat-Schnittstellen, REPLs
49* **Antwortgesteuerte Logik** - Wenn die nächste Aktion von Claudes Antwort abhängt
50* **Sitzungskontrolle** - Explizite Verwaltung des Konversationslebenszyklus
51
52## Funktionen
53
54### `query()`
55
56Erstellt für jede Interaktion mit Claude Code eine neue Sitzung. Gibt einen asynchronen Iterator zurück, der Nachrichten bei ihrer Ankunft liefert. Jeder Aufruf von `query()` beginnt neu ohne Erinnerung an vorherige Interaktionen.
57
58```python theme={null}
59async def query(
60 *,
61 prompt: str | AsyncIterable[dict[str, Any]],
62 options: ClaudeAgentOptions | None = None,
63 transport: Transport | None = None
64) -> AsyncIterator[Message]
65```
66
67#### Parameter
68
69| Parameter | Typ | Beschreibung |
70| :---------- | :--------------------------- | :----------------------------------------------------------------------------------------- |
71| `prompt` | `str \| AsyncIterable[dict]` | Die Eingabeaufforderung als Zeichenkette oder asynchroner Iterator für den Streaming-Modus |
72| `options` | `ClaudeAgentOptions \| None` | Optionales Konfigurationsobjekt (standardmäßig `ClaudeAgentOptions()`, wenn None) |
73| `transport` | `Transport \| None` | Optionaler benutzerdefinierter Transport für die Kommunikation mit dem CLI-Prozess |
74
75#### Rückgabewert
76
77Gibt einen `AsyncIterator[Message]` zurück, der Nachrichten aus der Konversation liefert.
78
79#### Beispiel - Mit Optionen
80
81```python theme={null}
82import asyncio
83from claude_agent_sdk import query, ClaudeAgentOptions
84
85
86async def main():
87 options = ClaudeAgentOptions(
88 system_prompt="You are an expert Python developer",
89 permission_mode="acceptEdits",
90 cwd="/home/user/project",
91 )
92
93 async for message in query(prompt="Create a Python web server", options=options):
94 print(message)
95
96
97asyncio.run(main())
98```
99
100### `tool()`
101
102Dekorator zum Definieren von MCP-Tools mit Typsicherheit.
103
104```python theme={null}
105def tool(
106 name: str,
107 description: str,
108 input_schema: type | dict[str, Any],
109 annotations: ToolAnnotations | None = None
110) -> Callable[[Callable[[Any], Awaitable[dict[str, Any]]]], SdkMcpTool[Any]]
111```
112
113#### Parameter
114
115| Parameter | Typ | Beschreibung |
116| :------------- | :----------------------------------------------- | :------------------------------------------------------------------------------- |
117| `name` | `str` | Eindeutige Kennung für das Tool |
118| `description` | `str` | Lesbare Beschreibung, was das Tool tut |
119| `input_schema` | `type \| dict[str, Any]` | Schema, das die Eingabeparameter des Tools definiert (siehe unten) |
120| `annotations` | [`ToolAnnotations`](#tool-annotations)` \| None` | Optionale MCP-Tool-Anmerkungen, die Verhaltenshinweise für Clients bereitstellen |
121
122#### Eingabeschema-Optionen
123
1241. **Einfache Typ-Zuordnung** (empfohlen):
125
126 ```python theme={null}
127 {"text": str, "count": int, "enabled": bool}
128 ```
129
1302. **JSON-Schema-Format** (für komplexe Validierung):
131 ```python theme={null}
132 {
133 "type": "object",
134 "properties": {
135 "text": {"type": "string"},
136 "count": {"type": "integer", "minimum": 0},
137 },
138 "required": ["text"],
139 }
140 ```
141
142#### Rückgabewert
143
144Eine Dekoratorfunktion, die die Tool-Implementierung umhüllt und eine `SdkMcpTool`-Instanz zurückgibt.
145
146#### Beispiel
147
148```python theme={null}
149from claude_agent_sdk import tool
150from typing import Any
151
152
153@tool("greet", "Greet a user", {"name": str})
154async def greet(args: dict[str, Any]) -> dict[str, Any]:
155 return {"content": [{"type": "text", "text": f"Hello, {args['name']}!"}]}
156```
157
158#### `ToolAnnotations`
159
160Erneut exportiert aus `mcp.types` (auch verfügbar als `from claude_agent_sdk import ToolAnnotations`). Alle Felder sind optionale Hinweise; Clients sollten sich nicht auf sie für Sicherheitsentscheidungen verlassen.
161
162| Feld | Typ | Standard | Beschreibung |
163| :---------------- | :------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
164| `title` | `str \| None` | `None` | Lesbare Bezeichnung für das Tool |
165| `readOnlyHint` | `bool \| None` | `False` | Wenn `True`, ändert das Tool seine Umgebung nicht |
166| `destructiveHint` | `bool \| None` | `True` | Wenn `True`, kann das Tool destruktive Aktualisierungen durchführen (nur sinnvoll, wenn `readOnlyHint` `False` ist) |
167| `idempotentHint` | `bool \| None` | `False` | Wenn `True`, haben wiederholte Aufrufe mit denselben Argumenten keine zusätzliche Auswirkung (nur sinnvoll, wenn `readOnlyHint` `False` ist) |
168| `openWorldHint` | `bool \| None` | `True` | Wenn `True`, interagiert das Tool mit externen Entitäten (z. B. Websuche). Wenn `False`, ist die Domäne des Tools geschlossen (z. B. ein Memory-Tool) |
169
170```python theme={null}
171from claude_agent_sdk import tool, ToolAnnotations
172from typing import Any
173
174
175@tool(
176 "search",
177 "Search the web",
178 {"query": str},
179 annotations=ToolAnnotations(readOnlyHint=True, openWorldHint=True),
180)
181async def search(args: dict[str, Any]) -> dict[str, Any]:
182 return {"content": [{"type": "text", "text": f"Results for: {args['query']}"}]}
183```
184
185### `create_sdk_mcp_server()`
186
187Erstellt einen In-Process-MCP-Server, der in Ihrer Python-Anwendung ausgeführt wird.
188
189```python theme={null}
190def create_sdk_mcp_server(
191 name: str,
192 version: str = "1.0.0",
193 tools: list[SdkMcpTool[Any]] | None = None
194) -> McpSdkServerConfig
195```
196
197#### Parameter
198
199| Parameter | Typ | Standard | Beschreibung |
200| :-------- | :------------------------------ | :-------- | :----------------------------------------------------------------------- |
201| `name` | `str` | - | Eindeutige Kennung für den Server |
202| `version` | `str` | `"1.0.0"` | Versionsnummer des Servers |
203| `tools` | `list[SdkMcpTool[Any]] \| None` | `None` | Liste von Tool-Funktionen, die mit dem `@tool`-Dekorator erstellt wurden |
204
205#### Rückgabewert
206
207Gibt ein `McpSdkServerConfig`-Objekt zurück, das an `ClaudeAgentOptions.mcp_servers` übergeben werden kann.
208
209#### Beispiel
210
211```python theme={null}
212from claude_agent_sdk import tool, create_sdk_mcp_server
213
214
215@tool("add", "Add two numbers", {"a": float, "b": float})
216async def add(args):
217 return {"content": [{"type": "text", "text": f"Sum: {args['a'] + args['b']}"}]}
218
219
220@tool("multiply", "Multiply two numbers", {"a": float, "b": float})
221async def multiply(args):
222 return {"content": [{"type": "text", "text": f"Product: {args['a'] * args['b']}"}]}
223
224
225calculator = create_sdk_mcp_server(
226 name="calculator",
227 version="2.0.0",
228 tools=[add, multiply], # Pass decorated functions
229)
230
231# Use with Claude
232options = ClaudeAgentOptions(
233 mcp_servers={"calc": calculator},
234 allowed_tools=["mcp__calc__add", "mcp__calc__multiply"],
235)
236```
237
238### `list_sessions()`
239
240Listet vergangene Sitzungen mit Metadaten auf. Filtern Sie nach Projektverzeichnis oder listen Sie Sitzungen über alle Projekte auf. Synchron; gibt sofort zurück.
241
242```python theme={null}
243def list_sessions(
244 directory: str | None = None,
245 limit: int | None = None,
246 include_worktrees: bool = True
247) -> list[SDKSessionInfo]
248```
249
250#### Parameter
251
252| Parameter | Typ | Standard | Beschreibung |
253| :------------------ | :------------ | :------- | :---------------------------------------------------------------------------------------------------------------------------- |
254| `directory` | `str \| None` | `None` | Verzeichnis, für das Sitzungen aufgelistet werden sollen. Wenn weggelassen, werden Sitzungen über alle Projekte zurückgegeben |
255| `limit` | `int \| None` | `None` | Maximale Anzahl der zurückzugebenden Sitzungen |
256| `include_worktrees` | `bool` | `True` | Wenn `directory` sich in einem Git-Repository befindet, Sitzungen aus allen Worktree-Pfaden einbeziehen |
257
258#### Rückgabetyp: `SDKSessionInfo`
259
260| Eigenschaft | Typ | Beschreibung |
261| :-------------- | :------------ | :------------------------------------------------------------------------------------------------------ |
262| `session_id` | `str` | Eindeutige Sitzungskennung |
263| `summary` | `str` | Anzeigetitel: benutzerdefinierter Titel, automatisch generierte Zusammenfassung oder erste Aufforderung |
264| `last_modified` | `int` | Letzte Änderungszeit in Millisekunden seit Epoche |
265| `file_size` | `int \| None` | Sitzungsdateigröße in Bytes (`None` für Remote-Speicher-Backends) |
266| `custom_title` | `str \| None` | Vom Benutzer festgelegter Sitzungstitel |
267| `first_prompt` | `str \| None` | Erste aussagekräftige Benutzeraufforderung in der Sitzung |
268| `git_branch` | `str \| None` | Git-Branch am Ende der Sitzung |
269| `cwd` | `str \| None` | Arbeitsverzeichnis für die Sitzung |
270| `tag` | `str \| None` | Vom Benutzer festgelegtes Sitzungs-Tag (siehe [`tag_session()`](#tag-session)) |
271| `created_at` | `int \| None` | Sitzungserstellungszeit in Millisekunden seit Epoche |
272
273#### Beispiel
274
275Geben Sie die 10 neuesten Sitzungen für ein Projekt aus. Die Ergebnisse werden nach `last_modified` absteigend sortiert, daher ist das erste Element das neueste. Lassen Sie `directory` weg, um über alle Projekte zu suchen.
276
277```python theme={null}
278from claude_agent_sdk import list_sessions
279
280for session in list_sessions(directory="/path/to/project", limit=10):
281 print(f"{session.summary} ({session.session_id})")
282```
283
284### `get_session_messages()`
285
286Ruft Nachrichten aus einer vergangenen Sitzung ab. Synchron; gibt sofort zurück.
287
288```python theme={null}
289def get_session_messages(
290 session_id: str,
291 directory: str | None = None,
292 limit: int | None = None,
293 offset: int = 0
294) -> list[SessionMessage]
295```
296
297#### Parameter
298
299| Parameter | Typ | Standard | Beschreibung |
300| :----------- | :------------ | :----------- | :------------------------------------------------------------------------------- |
301| `session_id` | `str` | erforderlich | Die Sitzungs-ID, für die Nachrichten abgerufen werden sollen |
302| `directory` | `str \| None` | `None` | Projektverzeichnis zum Suchen. Wenn weggelassen, werden alle Projekte durchsucht |
303| `limit` | `int \| None` | `None` | Maximale Anzahl der zurückzugebenden Nachrichten |
304| `offset` | `int` | `0` | Anzahl der Nachrichten, die vom Anfang übersprungen werden sollen |
305
306#### Rückgabetyp: `SessionMessage`
307
308| Eigenschaft | Typ | Beschreibung |
309| :------------------- | :----------------------------- | :----------------------------------- |
310| `type` | `Literal["user", "assistant"]` | Nachrichtenrolle |
311| `uuid` | `str` | Eindeutige Nachrichtenkennung |
312| `session_id` | `str` | Sitzungskennung |
313| `message` | `Any` | Roher Nachrichteninhalt |
314| `parent_tool_use_id` | `None` | Reserviert für zukünftige Verwendung |
315
316#### Beispiel
317
318```python theme={null}
319from claude_agent_sdk import list_sessions, get_session_messages
320
321sessions = list_sessions(limit=1)
322if sessions:
323 messages = get_session_messages(sessions[0].session_id)
324 for msg in messages:
325 print(f"[{msg.type}] {msg.uuid}")
326```
327
328### `get_session_info()`
329
330Liest Metadaten für eine einzelne Sitzung nach ID, ohne das vollständige Projektverzeichnis zu durchsuchen. Synchron; gibt sofort zurück.
331
332```python theme={null}
333def get_session_info(
334 session_id: str,
335 directory: str | None = None,
336) -> SDKSessionInfo | None
337```
338
339#### Parameter
340
341| Parameter | Typ | Standard | Beschreibung |
342| :----------- | :------------ | :----------- | :------------------------------------------------------------------------------------ |
343| `session_id` | `str` | erforderlich | UUID der zu suchenden Sitzung |
344| `directory` | `str \| None` | `None` | Projektverzeichnispath. Wenn weggelassen, werden alle Projektverzeichnisse durchsucht |
345
346Gibt [`SDKSessionInfo`](#return-type-sdk-session-info) zurück, oder `None`, wenn die Sitzung nicht gefunden wird.
347
348#### Beispiel
349
350Suchen Sie die Metadaten einer einzelnen Sitzung, ohne das Projektverzeichnis zu durchsuchen. Nützlich, wenn Sie bereits eine Sitzungs-ID aus einem vorherigen Durchlauf haben.
351
352```python theme={null}
353from claude_agent_sdk import get_session_info
354
355info = get_session_info("550e8400-e29b-41d4-a716-446655440000")
356if info:
357 print(f"{info.summary} (branch: {info.git_branch}, tag: {info.tag})")
358```
359
360### `rename_session()`
361
362Benennt eine Sitzung um, indem ein benutzerdefinierter Titeleintrag angehängt wird. Wiederholte Aufrufe sind sicher; der neueste Titel gewinnt. Synchron.
363
364```python theme={null}
365def rename_session(
366 session_id: str,
367 title: str,
368 directory: str | None = None,
369) -> None
370```
371
372#### Parameter
373
374| Parameter | Typ | Standard | Beschreibung |
375| :----------- | :------------ | :----------- | :------------------------------------------------------------------------------------ |
376| `session_id` | `str` | erforderlich | UUID der umzubenennenden Sitzung |
377| `title` | `str` | erforderlich | Neuer Titel. Muss nach dem Entfernen von Leerzeichen nicht leer sein |
378| `directory` | `str \| None` | `None` | Projektverzeichnispath. Wenn weggelassen, werden alle Projektverzeichnisse durchsucht |
379
380Wirft `ValueError`, wenn `session_id` keine gültige UUID ist oder `title` leer ist; `FileNotFoundError`, wenn die Sitzung nicht gefunden werden kann.
381
382#### Beispiel
383
384Benennen Sie die neueste Sitzung um, damit sie später leichter zu finden ist. Der neue Titel wird in [`SDKSessionInfo.custom_title`](#return-type-sdk-session-info) bei nachfolgenden Lesevorgängen angezeigt.
385
386```python theme={null}
387from claude_agent_sdk import list_sessions, rename_session
388
389sessions = list_sessions(directory="/path/to/project", limit=1)
390if sessions:
391 rename_session(sessions[0].session_id, "Refactor auth module")
392```
393
394### `tag_session()`
395
396Markiert eine Sitzung mit einem Tag. Übergeben Sie `None`, um das Tag zu löschen. Wiederholte Aufrufe sind sicher; das neueste Tag gewinnt. Synchron.
397
398```python theme={null}
399def tag_session(
400 session_id: str,
401 tag: str | None,
402 directory: str | None = None,
403) -> None
404```
405
406#### Parameter
407
408| Parameter | Typ | Standard | Beschreibung |
409| :----------- | :------------ | :----------- | :------------------------------------------------------------------------------------ |
410| `session_id` | `str` | erforderlich | UUID der zu markierenden Sitzung |
411| `tag` | `str \| None` | erforderlich | Tag-Zeichenkette oder `None` zum Löschen. Unicode-bereinigt vor dem Speichern |
412| `directory` | `str \| None` | `None` | Projektverzeichnispath. Wenn weggelassen, werden alle Projektverzeichnisse durchsucht |
413
414Wirft `ValueError`, wenn `session_id` keine gültige UUID ist oder `tag` nach der Bereinigung leer ist; `FileNotFoundError`, wenn die Sitzung nicht gefunden werden kann.
415
416#### Beispiel
417
418Markieren Sie eine Sitzung mit einem Tag, und filtern Sie später nach diesem Tag. Übergeben Sie `None`, um ein vorhandenes Tag zu löschen.
419
420```python theme={null}
421from claude_agent_sdk import list_sessions, tag_session
422
423# Tag a session
424tag_session("550e8400-e29b-41d4-a716-446655440000", "needs-review")
425
426# Later: find all sessions with that tag
427for session in list_sessions(directory="/path/to/project"):
428 if session.tag == "needs-review":
429 print(session.summary)
430```
431
432## Klassen
433
434### `ClaudeSDKClient`
435
436**Behält eine Konversationssitzung über mehrere Austausche hinweg bei.** Dies ist das Python-Äquivalent dazu, wie die `query()`-Funktion des TypeScript SDK intern funktioniert - sie erstellt ein Client-Objekt, das Konversationen fortsetzen kann.
437
438#### Wichtige Funktionen
439
440* **Sitzungskontinuität**: Behält Konversationskontext über mehrere `query()`-Aufrufe hinweg bei
441* **Gleiche Konversation**: Die Sitzung behält vorherige Nachrichten bei
442* **Unterbrechungsunterstützung**: Kann die Ausführung mitten in einer Aufgabe stoppen
443* **Expliziter Lebenszyklus**: Sie kontrollieren, wann die Sitzung beginnt und endet
444* **Antwortgesteuerte Abläufe**: Kann auf Antworten reagieren und Nachfolgefragen senden
445* **Benutzerdefinierte Tools und Hooks**: Unterstützt benutzerdefinierte Tools (erstellt mit dem `@tool`-Dekorator) und Hooks
446
447```python theme={null}
448class ClaudeSDKClient:
449 def __init__(self, options: ClaudeAgentOptions | None = None, transport: Transport | None = None)
450 async def connect(self, prompt: str | AsyncIterable[dict] | None = None) -> None
451 async def query(self, prompt: str | AsyncIterable[dict], session_id: str = "default") -> None
452 async def receive_messages(self) -> AsyncIterator[Message]
453 async def receive_response(self) -> AsyncIterator[Message]
454 async def interrupt(self) -> None
455 async def set_permission_mode(self, mode: str) -> None
456 async def set_model(self, model: str | None = None) -> None
457 async def rewind_files(self, user_message_id: str) -> None
458 async def get_mcp_status(self) -> McpStatusResponse
459 async def reconnect_mcp_server(self, server_name: str) -> None
460 async def toggle_mcp_server(self, server_name: str, enabled: bool) -> None
461 async def stop_task(self, task_id: str) -> None
462 async def get_server_info(self) -> dict[str, Any] | None
463 async def disconnect(self) -> None
464```
465
466#### Methoden
467
468| Methode | Beschreibung |
469| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
470| `__init__(options)` | Initialisieren Sie den Client mit optionaler Konfiguration |
471| `connect(prompt)` | Verbinden Sie sich mit Claude mit einer optionalen anfänglichen Aufforderung oder einem Nachrichtenstrom |
472| `query(prompt, session_id)` | Senden Sie eine neue Anfrage im Streaming-Modus |
473| `receive_messages()` | Empfangen Sie alle Nachrichten von Claude als asynchronen Iterator |
474| `receive_response()` | Empfangen Sie Nachrichten bis einschließlich einer ResultMessage |
475| `interrupt()` | Senden Sie ein Unterbrechungssignal (funktioniert nur im Streaming-Modus) |
476| `set_permission_mode(mode)` | Ändern Sie den Berechtigungsmodus für die aktuelle Sitzung |
477| `set_model(model)` | Ändern Sie das Modell für die aktuelle Sitzung. Übergeben Sie `None`, um auf Standard zurückzusetzen |
478| `rewind_files(user_message_id)` | Stellen Sie Dateien in ihren Zustand bei der angegebenen Benutzernachricht wieder her. Erfordert `enable_file_checkpointing=True`. Siehe [Datei-Checkpointing](/de/agent-sdk/file-checkpointing) |
479| `get_mcp_status()` | Rufen Sie den Status aller konfigurierten MCP-Server ab. Gibt [`McpStatusResponse`](#mcp-status-response) zurück |
480| `reconnect_mcp_server(server_name)` | Versuchen Sie, eine Verbindung zu einem MCP-Server herzustellen, der fehlgeschlagen ist oder getrennt wurde |
481| `toggle_mcp_server(server_name, enabled)` | Aktivieren oder deaktivieren Sie einen MCP-Server während der Sitzung. Das Deaktivieren entfernt seine Tools |
482| `stop_task(task_id)` | Stoppen Sie eine laufende Hintergrundaufgabe. Eine [`TaskNotificationMessage`](#task-notification-message) mit Status `"stopped"` folgt im Nachrichtenstrom |
483| `get_server_info()` | Rufen Sie Serverinformationen einschließlich Sitzungs-ID und Funktionen ab |
484| `disconnect()` | Trennen Sie die Verbindung zu Claude |
485
486#### Context Manager-Unterstützung
487
488Der Client kann als asynchroner Context Manager für automatische Verbindungsverwaltung verwendet werden:
489
490```python theme={null}
491async with ClaudeSDKClient() as client:
492 await client.query("Hello Claude")
493 async for message in client.receive_response():
494 print(message)
495```
496
497> **Wichtig:** Vermeiden Sie bei der Iteration über Nachrichten die Verwendung von `break`, um vorzeitig zu beenden, da dies zu asyncio-Bereinigungsproblemen führen kann. Lassen Sie die Iteration stattdessen natürlich abschließen oder verwenden Sie Flags, um zu verfolgen, wann Sie gefunden haben, was Sie brauchen.
498
499#### Beispiel - Konversation fortsetzen
500
501```python theme={null}
502import asyncio
503from claude_agent_sdk import ClaudeSDKClient, AssistantMessage, TextBlock, ResultMessage
504
505
506async def main():
507 async with ClaudeSDKClient() as client:
508 # First question
509 await client.query("What's the capital of France?")
510
511 # Process response
512 async for message in client.receive_response():
513 if isinstance(message, AssistantMessage):
514 for block in message.content:
515 if isinstance(block, TextBlock):
516 print(f"Claude: {block.text}")
517
518 # Follow-up question - the session retains the previous context
519 await client.query("What's the population of that city?")
520
521 async for message in client.receive_response():
522 if isinstance(message, AssistantMessage):
523 for block in message.content:
524 if isinstance(block, TextBlock):
525 print(f"Claude: {block.text}")
526
527 # Another follow-up - still in the same conversation
528 await client.query("What are some famous landmarks there?")
529
530 async for message in client.receive_response():
531 if isinstance(message, AssistantMessage):
532 for block in message.content:
533 if isinstance(block, TextBlock):
534 print(f"Claude: {block.text}")
535
536
537asyncio.run(main())
538```
539
540#### Beispiel - Streaming-Eingabe mit ClaudeSDKClient
541
542```python theme={null}
543import asyncio
544from claude_agent_sdk import ClaudeSDKClient
545
546
547async def message_stream():
548 """Generate messages dynamically."""
549 yield {
550 "type": "user",
551 "message": {"role": "user", "content": "Analyze the following data:"},
552 }
553 await asyncio.sleep(0.5)
554 yield {
555 "type": "user",
556 "message": {"role": "user", "content": "Temperature: 25°C, Humidity: 60%"},
557 }
558 await asyncio.sleep(0.5)
559 yield {
560 "type": "user",
561 "message": {"role": "user", "content": "What patterns do you see?"},
562 }
563
564
565async def main():
566 async with ClaudeSDKClient() as client:
567 # Stream input to Claude
568 await client.query(message_stream())
569
570 # Process response
571 async for message in client.receive_response():
572 print(message)
573
574 # Follow-up in same session
575 await client.query("Should we be concerned about these readings?")
576
577 async for message in client.receive_response():
578 print(message)
579
580
581asyncio.run(main())
582```
583
584#### Beispiel - Unterbrechungen verwenden
585
586```python theme={null}
587import asyncio
588from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, ResultMessage
589
590
591async def interruptible_task():
592 options = ClaudeAgentOptions(allowed_tools=["Bash"], permission_mode="acceptEdits")
593
594 async with ClaudeSDKClient(options=options) as client:
595 # Start a long-running task
596 await client.query("Count from 1 to 100 slowly, using the bash sleep command")
597
598 # Let it run for a bit
599 await asyncio.sleep(2)
600
601 # Interrupt the task
602 await client.interrupt()
603 print("Task interrupted!")
604
605 # Drain the interrupted task's messages (including its ResultMessage)
606 async for message in client.receive_response():
607 if isinstance(message, ResultMessage):
608 print(f"Interrupted task finished with subtype={message.subtype!r}")
609 # subtype is "error_during_execution" for interrupted tasks
610
611 # Send a new command
612 await client.query("Just say hello instead")
613
614 # Now receive the new response
615 async for message in client.receive_response():
616 if isinstance(message, ResultMessage) and message.subtype == "success":
617 print(f"New result: {message.result}")
618
619
620asyncio.run(interruptible_task())
621```
622
623<Note>
624 **Pufferverhalten nach Unterbrechung:** `interrupt()` sendet ein Stopsignal, löscht aber nicht den Nachrichtenpuffer. Nachrichten, die bereits von der unterbrochenen Aufgabe produziert wurden, einschließlich ihrer `ResultMessage` (mit `subtype="error_during_execution"`), bleiben im Stream. Sie müssen sie mit `receive_response()` entleeren, bevor Sie die Antwort auf eine neue Abfrage lesen. Wenn Sie unmittelbar nach `interrupt()` eine neue Abfrage senden und `receive_response()` nur einmal aufrufen, erhalten Sie die Nachrichten der unterbrochenen Aufgabe, nicht die Antwort der neuen Abfrage.
625</Note>
626
627#### Beispiel - Erweiterte Berechtigungskontrolle
628
629```python theme={null}
630from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions
631from claude_agent_sdk.types import (
632 PermissionResultAllow,
633 PermissionResultDeny,
634 ToolPermissionContext,
635)
636
637
638async def custom_permission_handler(
639 tool_name: str, input_data: dict, context: ToolPermissionContext
640) -> PermissionResultAllow | PermissionResultDeny:
641 """Custom logic for tool permissions."""
642
643 # Block writes to system directories
644 if tool_name == "Write" and input_data.get("file_path", "").startswith("/system/"):
645 return PermissionResultDeny(
646 message="System directory write not allowed", interrupt=True
647 )
648
649 # Redirect sensitive file operations
650 if tool_name in ["Write", "Edit"] and "config" in input_data.get("file_path", ""):
651 safe_path = f"./sandbox/{input_data['file_path']}"
652 return PermissionResultAllow(
653 updated_input={**input_data, "file_path": safe_path}
654 )
655
656 # Allow everything else
657 return PermissionResultAllow(updated_input=input_data)
658
659
660async def main():
661 options = ClaudeAgentOptions(
662 can_use_tool=custom_permission_handler, allowed_tools=["Read", "Write", "Edit"]
663 )
664
665 async with ClaudeSDKClient(options=options) as client:
666 await client.query("Update the system config file")
667
668 async for message in client.receive_response():
669 # Will use sandbox path instead
670 print(message)
671
672
673asyncio.run(main())
674```
675
676## Typen
677
678<Note>
679 **`@dataclass` vs `TypedDict`:** Dieses SDK verwendet zwei Arten von Typen. Klassen, die mit `@dataclass` dekoriert sind (wie `ResultMessage`, `AgentDefinition`, `TextBlock`), sind zur Laufzeit Objektinstanzen und unterstützen Attributzugriff: `msg.result`. Klassen, die mit `TypedDict` definiert sind (wie `ThinkingConfigEnabled`, `McpStdioServerConfig`, `SyncHookJSONOutput`), sind **zur Laufzeit einfache Dicts** und erfordern Schlüsselzugriff: `config["budget_tokens"]`, nicht `config.budget_tokens`. Die `ClassName(field=value)`-Aufrufsyntax funktioniert für beide, aber nur Dataclasses erzeugen Objekte mit Attributen.
680</Note>
681
682### `SdkMcpTool`
683
684Definition für ein SDK MCP-Tool, das mit dem `@tool`-Dekorator erstellt wurde.
685
686```python theme={null}
687@dataclass
688class SdkMcpTool(Generic[T]):
689 name: str
690 description: str
691 input_schema: type[T] | dict[str, Any]
692 handler: Callable[[T], Awaitable[dict[str, Any]]]
693 annotations: ToolAnnotations | None = None
694```
695
696| Eigenschaft | Typ | Beschreibung |
697| :------------- | :----------------------------------------- | :--------------------------------------------------------------------------------------------------------- |
698| `name` | `str` | Eindeutige Kennung für das Tool |
699| `description` | `str` | Lesbare Beschreibung |
700| `input_schema` | `type[T] \| dict[str, Any]` | Schema für Eingabevalidierung |
701| `handler` | `Callable[[T], Awaitable[dict[str, Any]]]` | Asynchrone Funktion, die die Tool-Ausführung handhabt |
702| `annotations` | `ToolAnnotations \| None` | Optionale MCP-Tool-Anmerkungen (z. B. `readOnlyHint`, `destructiveHint`, `openWorldHint`). Aus `mcp.types` |
703
704### `Transport`
705
706Abstrakte Basisklasse für benutzerdefinierte Transport-Implementierungen. Verwenden Sie dies, um mit dem Claude-Prozess über einen benutzerdefinierten Kanal zu kommunizieren (z. B. eine Remote-Verbindung statt eines lokalen Subprozesses).
707
708<Warning>
709 Dies ist eine Low-Level-interne API. Die Schnittstelle kann sich in zukünftigen Versionen ändern. Benutzerdefinierte Implementierungen müssen aktualisiert werden, um Schnittstellenänderungen zu entsprechen.
710</Warning>
711
712```python theme={null}
713from abc import ABC, abstractmethod
714from collections.abc import AsyncIterator
715from typing import Any
716
717
718class Transport(ABC):
719 @abstractmethod
720 async def connect(self) -> None: ...
721
722 @abstractmethod
723 async def write(self, data: str) -> None: ...
724
725 @abstractmethod
726 def read_messages(self) -> AsyncIterator[dict[str, Any]]: ...
727
728 @abstractmethod
729 async def close(self) -> None: ...
730
731 @abstractmethod
732 def is_ready(self) -> bool: ...
733
734 @abstractmethod
735 async def end_input(self) -> None: ...
736```
737
738| Methode | Beschreibung |
739| :---------------- | :------------------------------------------------------------------------- |
740| `connect()` | Verbinden Sie den Transport und bereiten Sie ihn für die Kommunikation vor |
741| `write(data)` | Schreiben Sie Rohdaten (JSON + Zeilenumbruch) in den Transport |
742| `read_messages()` | Asynchroner Iterator, der geparste JSON-Nachrichten liefert |
743| `close()` | Schließen Sie die Verbindung und bereinigen Sie Ressourcen |
744| `is_ready()` | Gibt `True` zurück, wenn der Transport senden und empfangen kann |
745| `end_input()` | Schließen Sie den Eingabestrom (z. B. stdin für Subprozess-Transporte) |
746
747Import: `from claude_agent_sdk import Transport`
748
749### `ClaudeAgentOptions`
750
751Konfigurationsdatenklasse für Claude Code-Abfragen.
752
753```python theme={null}
754@dataclass
755class ClaudeAgentOptions:
756 tools: list[str] | ToolsPreset | None = None
757 allowed_tools: list[str] = field(default_factory=list)
758 system_prompt: str | SystemPromptPreset | None = None
759 mcp_servers: dict[str, McpServerConfig] | str | Path = field(default_factory=dict)
760 permission_mode: PermissionMode | None = None
761 continue_conversation: bool = False
762 resume: str | None = None
763 max_turns: int | None = None
764 max_budget_usd: float | None = None
765 disallowed_tools: list[str] = field(default_factory=list)
766 model: str | None = None
767 fallback_model: str | None = None
768 betas: list[SdkBeta] = field(default_factory=list)
769 output_format: dict[str, Any] | None = None
770 permission_prompt_tool_name: str | None = None
771 cwd: str | Path | None = None
772 cli_path: str | Path | None = None
773 settings: str | None = None
774 add_dirs: list[str | Path] = field(default_factory=list)
775 env: dict[str, str] = field(default_factory=dict)
776 extra_args: dict[str, str | None] = field(default_factory=dict)
777 max_buffer_size: int | None = None
778 debug_stderr: Any = sys.stderr # Deprecated
779 stderr: Callable[[str], None] | None = None
780 can_use_tool: CanUseTool | None = None
781 hooks: dict[HookEvent, list[HookMatcher]] | None = None
782 user: str | None = None
783 include_partial_messages: bool = False
784 fork_session: bool = False
785 agents: dict[str, AgentDefinition] | None = None
786 setting_sources: list[SettingSource] | None = None
787 sandbox: SandboxSettings | None = None
788 plugins: list[SdkPluginConfig] = field(default_factory=list)
789 max_thinking_tokens: int | None = None # Deprecated: use thinking instead
790 thinking: ThinkingConfig | None = None
791 effort: Literal["low", "medium", "high", "max"] | None = None
792 enable_file_checkpointing: bool = False
793 session_store: SessionStore | None = None
794```
795
796| Eigenschaft | Typ | Standard | Beschreibung |
797| :---------------------------- | :------------------------------------------------------------------------------------- | :---------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
798| `tools` | `list[str] \| ToolsPreset \| None` | `None` | Tools-Konfiguration. Verwenden Sie `{"type": "preset", "preset": "claude_code"}` für die Standard-Tools von Claude Code |
799| `allowed_tools` | `list[str]` | `[]` | Tools, die automatisch genehmigt werden, ohne zu fragen. Dies beschränkt Claude nicht nur auf diese Tools; nicht aufgelistete Tools fallen durch `permission_mode` und `can_use_tool`. Verwenden Sie `disallowed_tools`, um Tools zu blockieren. Siehe [Berechtigungen](/de/agent-sdk/permissions#allow-and-deny-rules) |
800| `system_prompt` | `str \| SystemPromptPreset \| None` | `None` | System-Prompt-Konfiguration. Übergeben Sie eine Zeichenkette für einen benutzerdefinierten Prompt, oder verwenden Sie `{"type": "preset", "preset": "claude_code"}` für den System-Prompt von Claude Code. Fügen Sie `"append"` hinzu, um den Preset zu erweitern |
801| `mcp_servers` | `dict[str, McpServerConfig] \| str \| Path` | `{}` | MCP-Server-Konfigurationen oder Pfad zur Konfigurationsdatei |
802| `permission_mode` | `PermissionMode \| None` | `None` | Berechtigungsmodus für die Tool-Nutzung |
803| `continue_conversation` | `bool` | `False` | Setzen Sie die neueste Konversation fort |
804| `resume` | `str \| None` | `None` | Sitzungs-ID zum Fortsetzen |
805| `max_turns` | `int \| None` | `None` | Maximale agentengesteuerte Umdrehungen (Tool-Use-Rundgänge) |
806| `max_budget_usd` | `float \| None` | `None` | Stoppen Sie die Abfrage, wenn die clientseitige Kostenschätzung diesen USD-Wert erreicht. Verglichen mit der gleichen Schätzung wie `total_cost_usd`; siehe [Kosten und Nutzung verfolgen](/de/agent-sdk/cost-tracking) für Genauigkeitsvorbehalt |
807| `disallowed_tools` | `list[str]` | `[]` | Tools, die immer verweigert werden. Ablehnungsregeln werden zuerst überprüft und überschreiben `allowed_tools` und `permission_mode` (einschließlich `bypassPermissions`) |
808| `enable_file_checkpointing` | `bool` | `False` | Aktivieren Sie die Dateienänderungsverfolgung zum Zurückspulen. Siehe [Datei-Checkpointing](/de/agent-sdk/file-checkpointing) |
809| `model` | `str \| None` | `None` | Claude-Modell zum Verwenden |
810| `fallback_model` | `str \| None` | `None` | Fallback-Modell, das verwendet wird, wenn das primäre Modell fehlschlägt |
811| `betas` | `list[SdkBeta]` | `[]` | Beta-Funktionen zum Aktivieren. Siehe [`SdkBeta`](#sdk-beta) für verfügbare Optionen |
812| `output_format` | `dict[str, Any] \| None` | `None` | Ausgabeformat für strukturierte Antworten (z. B. `{"type": "json_schema", "schema": {...}}`). Siehe [Strukturierte Ausgaben](/de/agent-sdk/structured-outputs) für Details |
813| `permission_prompt_tool_name` | `str \| None` | `None` | MCP-Tool-Name für Berechtigungsaufforderungen |
814| `cwd` | `str \| Path \| None` | `None` | Aktuelles Arbeitsverzeichnis |
815| `cli_path` | `str \| Path \| None` | `None` | Benutzerdefinierter Pfad zur Claude Code CLI-Ausführungsdatei |
816| `settings` | `str \| None` | `None` | Pfad zur Einstellungsdatei |
817| `add_dirs` | `list[str \| Path]` | `[]` | Zusätzliche Verzeichnisse, auf die Claude zugreifen kann |
818| `env` | `dict[str, str]` | `{}` | Umgebungsvariablen, die auf der geerbten Prozessumgebung zusammengeführt werden. Siehe [Umgebungsvariablen](/de/env-vars) für Variablen, die die zugrunde liegende CLI liest |
819| `extra_args` | `dict[str, str \| None]` | `{}` | Zusätzliche CLI-Argumente, die direkt an die CLI übergeben werden |
820| `max_buffer_size` | `int \| None` | `None` | Maximale Bytes beim Puffern der CLI-Stdout |
821| `debug_stderr` | `Any` | `sys.stderr` | *Veraltet* - Dateiähnliches Objekt für Debug-Ausgabe. Verwenden Sie stattdessen den `stderr`-Callback |
822| `stderr` | `Callable[[str], None] \| None` | `None` | Callback-Funktion für stderr-Ausgabe von CLI |
823| `can_use_tool` | [`CanUseTool`](#can-use-tool) ` \| None` | `None` | Tool-Berechtigungs-Callback-Funktion. Siehe [Berechtigungstypen](#can-use-tool) für Details |
824| `hooks` | `dict[HookEvent, list[HookMatcher]] \| None` | `None` | Hook-Konfigurationen zum Abfangen von Ereignissen |
825| `user` | `str \| None` | `None` | Benutzerkennung |
826| `include_partial_messages` | `bool` | `False` | Schließen Sie partielle Nachrichtenstreaming-Ereignisse ein. Wenn aktiviert, werden [`StreamEvent`](#stream-event)-Nachrichten geliefert |
827| `fork_session` | `bool` | `False` | Wenn Sie mit `resume` fortsetzen, verzweigen Sie sich zu einer neuen Sitzungs-ID, anstatt die ursprüngliche Sitzung fortzusetzen |
828| `agents` | `dict[str, AgentDefinition] \| None` | `None` | Programmgesteuert definierte Subagenten |
829| `plugins` | `list[SdkPluginConfig]` | `[]` | Laden Sie benutzerdefinierte Plugins aus lokalen Pfaden. Siehe [Plugins](/de/agent-sdk/plugins) für Details |
830| `sandbox` | [`SandboxSettings`](#sandbox-settings) ` \| None` | `None` | Konfigurieren Sie das Sandbox-Verhalten programmgesteuert. Siehe [Sandbox-Einstellungen](#sandbox-settings) für Details |
831| `setting_sources` | `list[SettingSource] \| None` | `None` (CLI-Standard: alle Quellen) | Kontrollieren Sie, welche Dateisystem-Einstellungen geladen werden. Übergeben Sie `[]`, um Benutzer-, Projekt- und lokale Einstellungen zu deaktivieren. Verwaltete Richtlinieneinstellungen werden unabhängig davon geladen. Siehe [Claude Code-Funktionen verwenden](/de/agent-sdk/claude-code-features#what-settingsources-does-not-control) |
832| `max_thinking_tokens` | `int \| None` | `None` | *Veraltet* - Maximale Token für Thinking-Blöcke. Verwenden Sie stattdessen `thinking` |
833| `thinking` | [`ThinkingConfig`](#thinking-config) ` \| None` | `None` | Steuert das Verhalten des erweiterten Denkens. Hat Vorrang vor `max_thinking_tokens` |
834| `effort` | `Literal["low", "medium", "high", "max"] \| None` | `None` | Anstrengungsstufe für die Denktiefe |
835| `session_store` | [`SessionStore`](/de/agent-sdk/session-storage#the-session-store-interface) ` \| None` | `None` | Spiegeln Sie Sitzungstranskripte zu einem externen Backend, damit jeder Host sie fortsetzen kann. Siehe [Sitzungen im externen Speicher beibehalten](/de/agent-sdk/session-storage) |
836
837### `OutputFormat`
838
839Konfiguration für die Validierung strukturierter Ausgaben. Übergeben Sie dies als `dict` an das Feld `output_format` auf `ClaudeAgentOptions`:
840
841```python theme={null}
842# Expected dict shape for output_format
843{
844 "type": "json_schema",
845 "schema": {...}, # Your JSON Schema definition
846}
847```
848
849| Feld | Erforderlich | Beschreibung |
850| :------- | :----------- | :---------------------------------------------------- |
851| `type` | Ja | Muss `"json_schema"` für JSON-Schema-Validierung sein |
852| `schema` | Ja | JSON-Schema-Definition für Ausgabevalidierung |
853
854### `SystemPromptPreset`
855
856Konfiguration für die Verwendung des Preset-System-Prompts von Claude Code mit optionalen Ergänzungen.
857
858```python theme={null}
859class SystemPromptPreset(TypedDict):
860 type: Literal["preset"]
861 preset: Literal["claude_code"]
862 append: NotRequired[str]
863 exclude_dynamic_sections: NotRequired[bool]
864```
865
866| Feld | Erforderlich | Beschreibung |
867| :------------------------- | :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
868| `type` | Ja | Muss `"preset"` sein, um einen Preset-System-Prompt zu verwenden |
869| `preset` | Ja | Muss `"claude_code"` sein, um den System-Prompt von Claude Code zu verwenden |
870| `append` | Nein | Zusätzliche Anweisungen, die an den Preset-System-Prompt angehängt werden |
871| `exclude_dynamic_sections` | Nein | Verschieben Sie sitzungsspezifischen Kontext wie Arbeitsverzeichnis, Git-Status und Memory-Pfade aus dem System-Prompt in die erste Benutzernachricht. Verbessert die Prompt-Cache-Wiederverwendung über Benutzer und Maschinen hinweg. Siehe [System-Prompts ändern](/de/agent-sdk/modifying-system-prompts#improve-prompt-caching-across-users-and-machines) |
872
873### `SettingSource`
874
875Steuert, welche dateisystembasierte Konfigurationsquellen das SDK Einstellungen aus lädt.
876
877```python theme={null}
878SettingSource = Literal["user", "project", "local"]
879```
880
881| Wert | Beschreibung | Ort |
882| :---------- | :----------------------------------------------------- | :---------------------------- |
883| `"user"` | Globale Benutzereinstellungen | `~/.claude/settings.json` |
884| `"project"` | Gemeinsame Projekteinstellungen (versionskontrolliert) | `.claude/settings.json` |
885| `"local"` | Lokale Projekteinstellungen (gitignoriert) | `.claude/settings.local.json` |
886
887#### Standardverhalten
888
889Wenn `setting_sources` weggelassen oder `None` ist, lädt `query()` die gleichen Dateisystem-Einstellungen wie die Claude Code CLI: Benutzer, Projekt und lokal. Verwaltete Richtlinieneinstellungen werden in allen Fällen geladen. Siehe [Was settingSources nicht kontrolliert](/de/agent-sdk/claude-code-features#what-settingsources-does-not-control) für Eingaben, die unabhängig von dieser Option gelesen werden, und wie man sie deaktiviert.
890
891#### Warum setting\_sources verwenden
892
893**Dateisystem-Einstellungen deaktivieren:**
894
895```python theme={null}
896# Do not load user, project, or local settings from disk
897from claude_agent_sdk import query, ClaudeAgentOptions
898
899async for message in query(
900 prompt="Analyze this code",
901 options=ClaudeAgentOptions(
902 setting_sources=[]
903 ),
904):
905 print(message)
906```
907
908<Note>
909 Im Python SDK 0.1.59 und früher wurde eine leere Liste gleich behandelt wie das Weglassen der Option, daher hatte `setting_sources=[]` keine Auswirkung auf die Deaktivierung von Dateisystem-Einstellungen. Aktualisieren Sie auf eine neuere Version, wenn Sie benötigen, dass eine leere Liste wirksam wird. Das TypeScript SDK ist nicht betroffen.
910</Note>
911
912**Alle Dateisystem-Einstellungen explizit laden:**
913
914```python theme={null}
915from claude_agent_sdk import query, ClaudeAgentOptions
916
917async for message in query(
918 prompt="Analyze this code",
919 options=ClaudeAgentOptions(
920 setting_sources=["user", "project", "local"]
921 ),
922):
923 print(message)
924```
925
926**Nur bestimmte Einstellungsquellen laden:**
927
928```python theme={null}
929# Load only project settings, ignore user and local
930async for message in query(
931 prompt="Run CI checks",
932 options=ClaudeAgentOptions(
933 setting_sources=["project"] # Only .claude/settings.json
934 ),
935):
936 print(message)
937```
938
939**Test- und CI-Umgebungen:**
940
941```python theme={null}
942# Ensure consistent behavior in CI by excluding local settings
943async for message in query(
944 prompt="Run tests",
945 options=ClaudeAgentOptions(
946 setting_sources=["project"], # Only team-shared settings
947 permission_mode="bypassPermissions",
948 ),
949):
950 print(message)
951```
952
953**SDK-only-Anwendungen:**
954
955```python theme={null}
956# Define everything programmatically.
957# Pass [] to opt out of filesystem setting sources.
958async for message in query(
959 prompt="Review this PR",
960 options=ClaudeAgentOptions(
961 setting_sources=[],
962 agents={...},
963 mcp_servers={...},
964 allowed_tools=["Read", "Grep", "Glob"],
965 ),
966):
967 print(message)
968```
969
970**Laden von CLAUDE.md-Projektanweisungen:**
971
972```python theme={null}
973# Load project settings to include CLAUDE.md files
974async for message in query(
975 prompt="Add a new feature following project conventions",
976 options=ClaudeAgentOptions(
977 system_prompt={
978 "type": "preset",
979 "preset": "claude_code", # Use Claude Code's system prompt
980 },
981 setting_sources=["project"], # Loads CLAUDE.md from project
982 allowed_tools=["Read", "Write", "Edit"],
983 ),
984):
985 print(message)
986```
987
988#### Einstellungspriorität
989
990Wenn mehrere Quellen geladen werden, werden Einstellungen mit dieser Priorität zusammengeführt (höchste zu niedrigste):
991
9921. Lokale Einstellungen (`.claude/settings.local.json`)
9932. Projekteinstellungen (`.claude/settings.json`)
9943. Benutzereinstellungen (`~/.claude/settings.json`)
995
996Programmgesteuerte Optionen wie `agents` und `allowed_tools` überschreiben Benutzer-, Projekt- und lokale Dateisystem-Einstellungen. Verwaltete Richtlinieneinstellungen haben Vorrang vor programmgesteuerten Optionen.
997
998### `AgentDefinition`
999
1000Konfiguration für einen programmgesteuert definierten Subagenten.
1001
1002```python theme={null}
1003@dataclass
1004class AgentDefinition:
1005 description: str
1006 prompt: str
1007 tools: list[str] | None = None
1008 disallowedTools: list[str] | None = None
1009 model: str | None = None
1010 skills: list[str] | None = None
1011 memory: Literal["user", "project", "local"] | None = None
1012 mcpServers: list[str | dict[str, Any]] | None = None
1013 initialPrompt: str | None = None
1014 maxTurns: int | None = None
1015 background: bool | None = None
1016 effort: Literal["low", "medium", "high", "max"] | int | None = None
1017 permissionMode: PermissionMode | None = None
1018```
1019
1020| Feld | Erforderlich | Beschreibung |
1021| :---------------- | :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1022| `description` | Ja | Natürlichsprachige Beschreibung, wann dieser Agent verwendet werden sollte |
1023| `prompt` | Ja | Der System-Prompt des Agenten |
1024| `tools` | Nein | Array von zulässigen Tool-Namen. Wenn weggelassen, erbt alle Tools |
1025| `disallowedTools` | Nein | Array von Tool-Namen, die aus dem Tool-Set des Agenten entfernt werden |
1026| `model` | Nein | Modell-Override für diesen Agenten. Akzeptiert einen Alias wie `"sonnet"`, `"opus"`, `"haiku"` oder `"inherit"`, oder eine vollständige Modell-ID. Wenn weggelassen, verwendet das Hauptmodell |
1027| `skills` | Nein | Liste von Skill-Namen, die diesem Agenten zur Verfügung stehen |
1028| `memory` | Nein | Memory-Quelle für diesen Agenten: `"user"`, `"project"` oder `"local"` |
1029| `mcpServers` | Nein | MCP-Server, die diesem Agenten zur Verfügung stehen. Jeder Eintrag ist ein Servername oder ein Inline-`{name: config}`-Dict |
1030| `initialPrompt` | Nein | Wird automatisch als erste Benutzerdrehung eingereicht, wenn dieser Agent als Haupt-Thread-Agent läuft |
1031| `maxTurns` | Nein | Maximale Anzahl von Agenten-Umdrehungen, bevor der Agent stoppt |
1032| `background` | Nein | Führen Sie diesen Agenten als nicht-blockierende Hintergrundaufgabe aus, wenn aufgerufen |
1033| `effort` | Nein | Reasoning-Anstrengungsstufe für diesen Agenten. Akzeptiert eine benannte Stufe oder eine Ganzzahl |
1034| `permissionMode` | Nein | Berechtigungsmodus für die Tool-Ausführung innerhalb dieses Agenten. Siehe [`PermissionMode`](#permission-mode) |
1035
1036<Note>
1037 `AgentDefinition`-Feldnamen verwenden camelCase, wie `disallowedTools`, `permissionMode` und `maxTurns`. Diese Namen werden direkt dem Drahtformat zugeordnet, das mit dem TypeScript SDK geteilt wird. Dies unterscheidet sich von `ClaudeAgentOptions`, das Python snake\_case für die entsprechenden Top-Level-Felder wie `disallowed_tools` und `permission_mode` verwendet. Da `AgentDefinition` eine Dataclass ist, wirft das Übergeben eines snake\_case-Schlüsselworts einen `TypeError` zur Konstruktionszeit auf.
1038</Note>
1039
1040### `PermissionMode`
1041
1042Berechtigungsmodi zur Kontrolle der Tool-Ausführung.
1043
1044```python theme={null}
1045PermissionMode = Literal[
1046 "default", # Standard permission behavior
1047 "acceptEdits", # Auto-accept file edits
1048 "plan", # Planning mode - no execution
1049 "dontAsk", # Deny anything not pre-approved instead of prompting
1050 "bypassPermissions", # Bypass all permission checks (use with caution)
1051]
1052```
1053
1054### `CanUseTool`
1055
1056Typ-Alias für Tool-Berechtigungs-Callback-Funktionen.
1057
1058```python theme={null}
1059CanUseTool = Callable[
1060 [str, dict[str, Any], ToolPermissionContext], Awaitable[PermissionResult]
1061]
1062```
1063
1064Der Callback empfängt:
1065
1066* `tool_name`: Name des aufgerufenen Tools
1067* `input_data`: Die Eingabeparameter des Tools
1068* `context`: Ein `ToolPermissionContext` mit zusätzlichen Informationen
1069
1070Gibt ein `PermissionResult` zurück (entweder `PermissionResultAllow` oder `PermissionResultDeny`).
1071
1072### `ToolPermissionContext`
1073
1074Kontextinformationen, die an Tool-Berechtigungs-Callbacks übergeben werden.
1075
1076```python theme={null}
1077@dataclass
1078class ToolPermissionContext:
1079 signal: Any | None = None # Future: abort signal support
1080 suggestions: list[PermissionUpdate] = field(default_factory=list)
1081```
1082
1083| Feld | Typ | Beschreibung |
1084| :------------ | :----------------------- | :--------------------------------------------------- |
1085| `signal` | `Any \| None` | Reserviert für zukünftige Abort-Signal-Unterstützung |
1086| `suggestions` | `list[PermissionUpdate]` | Berechtigungsaktualisierungsvorschläge von der CLI |
1087
1088### `PermissionResult`
1089
1090Union-Typ für Berechtigungs-Callback-Ergebnisse.
1091
1092```python theme={null}
1093PermissionResult = PermissionResultAllow | PermissionResultDeny
1094```
1095
1096### `PermissionResultAllow`
1097
1098Ergebnis, das angibt, dass der Tool-Aufruf zulässig sein sollte.
1099
1100```python theme={null}
1101@dataclass
1102class PermissionResultAllow:
1103 behavior: Literal["allow"] = "allow"
1104 updated_input: dict[str, Any] | None = None
1105 updated_permissions: list[PermissionUpdate] | None = None
1106```
1107
1108| Feld | Typ | Standard | Beschreibung |
1109| :-------------------- | :------------------------------- | :-------- | :------------------------------------------------------- |
1110| `behavior` | `Literal["allow"]` | `"allow"` | Muss "allow" sein |
1111| `updated_input` | `dict[str, Any] \| None` | `None` | Geänderte Eingabe, die stattdessen verwendet werden soll |
1112| `updated_permissions` | `list[PermissionUpdate] \| None` | `None` | Berechtigungsaktualisierungen zum Anwenden |
1113
1114### `PermissionResultDeny`
1115
1116Ergebnis, das angibt, dass der Tool-Aufruf verweigert werden sollte.
1117
1118```python theme={null}
1119@dataclass
1120class PermissionResultDeny:
1121 behavior: Literal["deny"] = "deny"
1122 message: str = ""
1123 interrupt: bool = False
1124```
1125
1126| Feld | Typ | Standard | Beschreibung |
1127| :---------- | :---------------- | :------- | :------------------------------------------------------ |
1128| `behavior` | `Literal["deny"]` | `"deny"` | Muss "deny" sein |
1129| `message` | `str` | `""` | Nachricht, die erklärt, warum das Tool verweigert wurde |
1130| `interrupt` | `bool` | `False` | Ob die aktuelle Ausführung unterbrochen werden soll |
1131
1132### `PermissionUpdate`
1133
1134Konfiguration zum programmgesteuerten Aktualisieren von Berechtigungen.
1135
1136```python theme={null}
1137@dataclass
1138class PermissionUpdate:
1139 type: Literal[
1140 "addRules",
1141 "replaceRules",
1142 "removeRules",
1143 "setMode",
1144 "addDirectories",
1145 "removeDirectories",
1146 ]
1147 rules: list[PermissionRuleValue] | None = None
1148 behavior: Literal["allow", "deny", "ask"] | None = None
1149 mode: PermissionMode | None = None
1150 directories: list[str] | None = None
1151 destination: (
1152 Literal["userSettings", "projectSettings", "localSettings", "session"] | None
1153 ) = None
1154```
1155
1156| Feld | Typ | Beschreibung |
1157| :------------ | :---------------------------------------- | :-------------------------------------------------------- |
1158| `type` | `Literal[...]` | Der Typ der Berechtigungsaktualisierungsoperation |
1159| `rules` | `list[PermissionRuleValue] \| None` | Regeln für Add/Replace/Remove-Operationen |
1160| `behavior` | `Literal["allow", "deny", "ask"] \| None` | Verhalten für regelbasierte Operationen |
1161| `mode` | `PermissionMode \| None` | Modus für setMode-Operation |
1162| `directories` | `list[str] \| None` | Verzeichnisse für Add/Remove-Verzeichnis-Operationen |
1163| `destination` | `Literal[...] \| None` | Wo die Berechtigungsaktualisierung angewendet werden soll |
1164
1165### `PermissionRuleValue`
1166
1167Eine Regel, die in einer Berechtigungsaktualisierung hinzugefügt, ersetzt oder entfernt werden soll.
1168
1169```python theme={null}
1170@dataclass
1171class PermissionRuleValue:
1172 tool_name: str
1173 rule_content: str | None = None
1174```
1175
1176### `ToolsPreset`
1177
1178Preset-Tools-Konfiguration für die Verwendung des Standard-Tool-Sets von Claude Code.
1179
1180```python theme={null}
1181class ToolsPreset(TypedDict):
1182 type: Literal["preset"]
1183 preset: Literal["claude_code"]
1184```
1185
1186### `ThinkingConfig`
1187
1188Steuert das Verhalten des erweiterten Denkens. Eine Union von drei Konfigurationen:
1189
1190```python theme={null}
1191class ThinkingConfigAdaptive(TypedDict):
1192 type: Literal["adaptive"]
1193
1194
1195class ThinkingConfigEnabled(TypedDict):
1196 type: Literal["enabled"]
1197 budget_tokens: int
1198
1199
1200class ThinkingConfigDisabled(TypedDict):
1201 type: Literal["disabled"]
1202
1203
1204ThinkingConfig = ThinkingConfigAdaptive | ThinkingConfigEnabled | ThinkingConfigDisabled
1205```
1206
1207| Variante | Felder | Beschreibung |
1208| :--------- | :---------------------- | :---------------------------------------------------------- |
1209| `adaptive` | `type` | Claude entscheidet adaptiv, wann gedacht werden soll |
1210| `enabled` | `type`, `budget_tokens` | Aktivieren Sie das Denken mit einem bestimmten Token-Budget |
1211| `disabled` | `type` | Deaktivieren Sie das Denken |
1212
1213Da dies `TypedDict`-Klassen sind, sind sie zur Laufzeit einfache Dicts. Konstruieren Sie sie entweder als Dict-Literale oder rufen Sie die Klasse wie einen Konstruktor auf; beide erzeugen ein `dict`. Greifen Sie auf Felder mit `config["budget_tokens"]` zu, nicht mit `config.budget_tokens`:
1214
1215```python theme={null}
1216from claude_agent_sdk import ClaudeAgentOptions, ThinkingConfigEnabled
1217
1218# Option 1: dict literal (recommended, no import needed)
1219options = ClaudeAgentOptions(thinking={"type": "enabled", "budget_tokens": 20000})
1220
1221# Option 2: constructor-style (returns a plain dict)
1222config = ThinkingConfigEnabled(type="enabled", budget_tokens=20000)
1223print(config["budget_tokens"]) # 20000
1224# config.budget_tokens would raise AttributeError
1225```
1226
1227### `SdkBeta`
1228
1229Literal-Typ für SDK-Beta-Funktionen.
1230
1231```python theme={null}
1232SdkBeta = Literal["context-1m-2025-08-07"]
1233```
1234
1235Verwenden Sie mit dem Feld `betas` in `ClaudeAgentOptions`, um Beta-Funktionen zu aktivieren.
1236
1237<Warning>
1238 Die `context-1m-2025-08-07`-Beta ist seit dem 30. April 2026 veraltet. Das Übergeben dieses Headers mit Claude Sonnet 4.5 oder Sonnet 4 hat keine Auswirkung, und Anfragen, die das Standard-200k-Token-Kontextfenster überschreiten, geben einen Fehler zurück. Um ein 1M-Token-Kontextfenster zu verwenden, migrieren Sie zu [Claude Sonnet 4.6, Claude Opus 4.6 oder Claude Opus 4.7](https://platform.claude.com/docs/en/about-claude/models/overview), die 1M-Kontext zu Standardpreisen ohne Beta-Header enthalten.
1239</Warning>
1240
1241### `McpSdkServerConfig`
1242
1243Konfiguration für SDK MCP-Server, die mit `create_sdk_mcp_server()` erstellt wurden.
1244
1245```python theme={null}
1246class McpSdkServerConfig(TypedDict):
1247 type: Literal["sdk"]
1248 name: str
1249 instance: Any # MCP Server instance
1250```
1251
1252### `McpServerConfig`
1253
1254Union-Typ für MCP-Server-Konfigurationen.
1255
1256```python theme={null}
1257McpServerConfig = (
1258 McpStdioServerConfig | McpSSEServerConfig | McpHttpServerConfig | McpSdkServerConfig
1259)
1260```
1261
1262#### `McpStdioServerConfig`
1263
1264```python theme={null}
1265class McpStdioServerConfig(TypedDict):
1266 type: NotRequired[Literal["stdio"]] # Optional for backwards compatibility
1267 command: str
1268 args: NotRequired[list[str]]
1269 env: NotRequired[dict[str, str]]
1270```
1271
1272#### `McpSSEServerConfig`
1273
1274```python theme={null}
1275class McpSSEServerConfig(TypedDict):
1276 type: Literal["sse"]
1277 url: str
1278 headers: NotRequired[dict[str, str]]
1279```
1280
1281#### `McpHttpServerConfig`
1282
1283```python theme={null}
1284class McpHttpServerConfig(TypedDict):
1285 type: Literal["http"]
1286 url: str
1287 headers: NotRequired[dict[str, str]]
1288```
1289
1290### `McpServerStatusConfig`
1291
1292Die Konfiguration eines MCP-Servers, wie von [`get_mcp_status()`](#methods) gemeldet. Dies ist die Union aller [`McpServerConfig`](#mcp-server-config)-Transport-Varianten plus eine nur-Ausgabe-`claudeai-proxy`-Variante für Server, die durch claude.ai proxiert werden.
1293
1294```python theme={null}
1295McpServerStatusConfig = (
1296 McpStdioServerConfig
1297 | McpSSEServerConfig
1298 | McpHttpServerConfig
1299 | McpSdkServerConfigStatus
1300 | McpClaudeAIProxyServerConfig
1301)
1302```
1303
1304`McpSdkServerConfigStatus` ist die serialisierbare Form von [`McpSdkServerConfig`](#mcp-sdk-server-config) mit nur `type` (`"sdk"`) und `name` (`str`)-Feldern; die In-Process-`instance` wird weggelassen. `McpClaudeAIProxyServerConfig` hat `type` (`"claudeai-proxy"`), `url` (`str`) und `id` (`str`)-Felder.
1305
1306### `McpStatusResponse`
1307
1308Antwort von [`ClaudeSDKClient.get_mcp_status()`](#methods). Umhüllt die Liste der Server-Status unter dem `mcpServers`-Schlüssel.
1309
1310```python theme={null}
1311class McpStatusResponse(TypedDict):
1312 mcpServers: list[McpServerStatus]
1313```
1314
1315### `McpServerStatus`
1316
1317Status eines verbundenen MCP-Servers, enthalten in [`McpStatusResponse`](#mcp-status-response).
1318
1319```python theme={null}
1320class McpServerStatus(TypedDict):
1321 name: str
1322 status: McpServerConnectionStatus # "connected" | "failed" | "needs-auth" | "pending" | "disabled"
1323 serverInfo: NotRequired[McpServerInfo]
1324 error: NotRequired[str]
1325 config: NotRequired[McpServerStatusConfig]
1326 scope: NotRequired[str]
1327 tools: NotRequired[list[McpToolInfo]]
1328```
1329
1330| Feld | Typ | Beschreibung |
1331| :----------- | :-------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1332| `name` | `str` | Servername |
1333| `status` | `str` | Einer von `"connected"`, `"failed"`, `"needs-auth"`, `"pending"` oder `"disabled"` |
1334| `serverInfo` | `dict` (optional) | Servername und Version (`{"name": str, "version": str}`) |
1335| `error` | `str` (optional) | Fehlermeldung, wenn der Server keine Verbindung herstellen konnte |
1336| `config` | [`McpServerStatusConfig`](#mcp-server-status-config) (optional) | Server-Konfiguration. Gleiche Form wie [`McpServerConfig`](#mcp-server-config) (stdio, SSE, HTTP oder SDK), plus eine `claudeai-proxy`-Variante für Server, die über claude.ai verbunden sind |
1337| `scope` | `str` (optional) | Konfigurationsbereich |
1338| `tools` | `list` (optional) | Tools, die von diesem Server bereitgestellt werden, jeweils mit `name`, `description` und `annotations`-Feldern |
1339
1340### `SdkPluginConfig`
1341
1342Konfiguration zum Laden von Plugins im SDK.
1343
1344```python theme={null}
1345class SdkPluginConfig(TypedDict):
1346 type: Literal["local"]
1347 path: str
1348```
1349
1350| Feld | Typ | Beschreibung |
1351| :----- | :----------------- | :------------------------------------------------------------------ |
1352| `type` | `Literal["local"]` | Muss `"local"` sein (derzeit werden nur lokale Plugins unterstützt) |
1353| `path` | `str` | Absoluter oder relativer Pfad zum Plugin-Verzeichnis |
1354
1355**Beispiel:**
1356
1357```python theme={null}
1358plugins = [
1359 {"type": "local", "path": "./my-plugin"},
1360 {"type": "local", "path": "/absolute/path/to/plugin"},
1361]
1362```
1363
1364Vollständige Informationen zum Erstellen und Verwenden von Plugins finden Sie unter [Plugins](/de/agent-sdk/plugins).
1365
1366## Nachrichtentypen
1367
1368### `Message`
1369
1370Union-Typ aller möglichen Nachrichten.
1371
1372```python theme={null}
1373Message = (
1374 UserMessage
1375 | AssistantMessage
1376 | SystemMessage
1377 | ResultMessage
1378 | StreamEvent
1379 | RateLimitEvent
1380)
1381```
1382
1383### `UserMessage`
1384
1385Benutzereingabe-Nachricht.
1386
1387```python theme={null}
1388@dataclass
1389class UserMessage:
1390 content: str | list[ContentBlock]
1391 uuid: str | None = None
1392 parent_tool_use_id: str | None = None
1393 tool_use_result: dict[str, Any] | None = None
1394```
1395
1396| Feld | Typ | Beschreibung |
1397| :------------------- | :-------------------------- | :--------------------------------------------------------------- |
1398| `content` | `str \| list[ContentBlock]` | Nachrichteninhalt als Text oder Inhaltsblöcke |
1399| `uuid` | `str \| None` | Eindeutige Nachrichtenkennung |
1400| `parent_tool_use_id` | `str \| None` | Tool-Use-ID, wenn diese Nachricht eine Tool-Ergebnis-Antwort ist |
1401| `tool_use_result` | `dict[str, Any] \| None` | Tool-Ergebnisdaten, falls zutreffend |
1402
1403### `AssistantMessage`
1404
1405Assistent-Antwortnachricht mit Inhaltsblöcken.
1406
1407```python theme={null}
1408@dataclass
1409class AssistantMessage:
1410 content: list[ContentBlock]
1411 model: str
1412 parent_tool_use_id: str | None = None
1413 error: AssistantMessageError | None = None
1414 usage: dict[str, Any] | None = None
1415 message_id: str | None = None
1416```
1417
1418| Feld | Typ | Beschreibung |
1419| :------------------- | :------------------------------------------------------------- | :------------------------------------------------------------------------------------------- |
1420| `content` | `list[ContentBlock]` | Liste von Inhaltsblöcken in der Antwort |
1421| `model` | `str` | Modell, das die Antwort generiert hat |
1422| `parent_tool_use_id` | `str \| None` | Tool-Use-ID, wenn dies eine verschachtelte Antwort ist |
1423| `error` | [`AssistantMessageError`](#assistant-message-error) ` \| None` | Fehlertyp, wenn die Antwort auf einen Fehler stieß |
1424| `usage` | `dict[str, Any] \| None` | Token-Nutzung pro Nachricht (gleiche Schlüssel wie [`ResultMessage.usage`](#result-message)) |
1425| `message_id` | `str \| None` | API-Nachrichtenkennung. Mehrere Nachrichten aus einer Umdrehung teilen die gleiche ID |
1426
1427### `AssistantMessageError`
1428
1429Mögliche Fehlertypen für Assistent-Nachrichten.
1430
1431```python theme={null}
1432AssistantMessageError = Literal[
1433 "authentication_failed",
1434 "billing_error",
1435 "rate_limit",
1436 "invalid_request",
1437 "server_error",
1438 "max_output_tokens",
1439 "unknown",
1440]
1441```
1442
1443### `SystemMessage`
1444
1445System-Nachricht mit Metadaten.
1446
1447```python theme={null}
1448@dataclass
1449class SystemMessage:
1450 subtype: str
1451 data: dict[str, Any]
1452```
1453
1454### `ResultMessage`
1455
1456Endgültige Ergebnis-Nachricht mit Kosten- und Nutzungsinformationen.
1457
1458```python theme={null}
1459@dataclass
1460class ResultMessage:
1461 subtype: str
1462 duration_ms: int
1463 duration_api_ms: int
1464 is_error: bool
1465 num_turns: int
1466 session_id: str
1467 total_cost_usd: float | None = None
1468 usage: dict[str, Any] | None = None
1469 result: str | None = None
1470 stop_reason: str | None = None
1471 structured_output: Any = None
1472 model_usage: dict[str, Any] | None = None
1473```
1474
1475Das `usage`-Dict enthält die folgenden Schlüssel, wenn vorhanden:
1476
1477| Schlüssel | Typ | Beschreibung |
1478| ----------------------------- | ----- | --------------------------------------------------------------- |
1479| `input_tokens` | `int` | Gesamte verbrauchte Eingabe-Token. |
1480| `output_tokens` | `int` | Gesamte generierte Ausgabe-Token. |
1481| `cache_creation_input_tokens` | `int` | Token, die zum Erstellen neuer Cache-Einträge verwendet wurden. |
1482| `cache_read_input_tokens` | `int` | Token, die aus vorhandenen Cache-Einträgen gelesen wurden. |
1483
1484Das `model_usage`-Dict ordnet Modellnamen der Nutzung pro Modell zu. Die inneren Dict-Schlüssel verwenden camelCase, da der Wert unverändert vom zugrunde liegenden CLI-Prozess übergeben wird und dem TypeScript [`ModelUsage`](/de/agent-sdk/typescript#model-usage)-Typ entspricht:
1485
1486| Schlüssel | Typ | Beschreibung |
1487| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1488| `inputTokens` | `int` | Eingabe-Token für dieses Modell. |
1489| `outputTokens` | `int` | Ausgabe-Token für dieses Modell. |
1490| `cacheReadInputTokens` | `int` | Cache-Lese-Token für dieses Modell. |
1491| `cacheCreationInputTokens` | `int` | Cache-Erstellungs-Token für dieses Modell. |
1492| `webSearchRequests` | `int` | Webbsuche-Anfragen, die von diesem Modell gestellt wurden. |
1493| `costUSD` | `float` | Geschätzte Kosten in USD für dieses Modell, clientseitig berechnet. Siehe [Kosten und Nutzung verfolgen](/de/agent-sdk/cost-tracking) für Abrechnungsvorbehalt. |
1494| `contextWindow` | `int` | Kontextfenstergröße für dieses Modell. |
1495| `maxOutputTokens` | `int` | Maximale Ausgabe-Token-Grenze für dieses Modell. |
1496
1497### `StreamEvent`
1498
1499Stream-Ereignis für partielle Nachrichtenaktualisierungen während des Streamings. Wird nur empfangen, wenn `include_partial_messages=True` in `ClaudeAgentOptions`. Import über `from claude_agent_sdk.types import StreamEvent`.
1500
1501```python theme={null}
1502@dataclass
1503class StreamEvent:
1504 uuid: str
1505 session_id: str
1506 event: dict[str, Any] # The raw Claude API stream event
1507 parent_tool_use_id: str | None = None
1508```
1509
1510| Feld | Typ | Beschreibung |
1511| :------------------- | :--------------- | :-------------------------------------------------------------------------- |
1512| `uuid` | `str` | Eindeutige Kennung für dieses Ereignis |
1513| `session_id` | `str` | Sitzungskennung |
1514| `event` | `dict[str, Any]` | Die rohen Claude API-Stream-Ereignisdaten |
1515| `parent_tool_use_id` | `str \| None` | Übergeordnete Tool-Use-ID, wenn dieses Ereignis von einem Subagenten stammt |
1516
1517### `RateLimitEvent`
1518
1519Wird ausgegeben, wenn sich der Rate-Limit-Status ändert (z. B. von `"allowed"` zu `"allowed_warning"`). Verwenden Sie dies, um Benutzer zu warnen, bevor sie eine harte Grenze erreichen, oder um zu backoff, wenn der Status `"rejected"` ist.
1520
1521```python theme={null}
1522@dataclass
1523class RateLimitEvent:
1524 rate_limit_info: RateLimitInfo
1525 uuid: str
1526 session_id: str
1527```
1528
1529| Feld | Typ | Beschreibung |
1530| :---------------- | :---------------------------------- | :-------------------------- |
1531| `rate_limit_info` | [`RateLimitInfo`](#rate-limit-info) | Aktueller Rate-Limit-Status |
1532| `uuid` | `str` | Eindeutige Ereigniskennung |
1533| `session_id` | `str` | Sitzungskennung |
1534
1535### `RateLimitInfo`
1536
1537Rate-Limit-Status, den [`RateLimitEvent`](#rate-limit-event) trägt.
1538
1539```python theme={null}
1540RateLimitStatus = Literal["allowed", "allowed_warning", "rejected"]
1541RateLimitType = Literal[
1542 "five_hour", "seven_day", "seven_day_opus", "seven_day_sonnet", "overage"
1543]
1544
1545
1546@dataclass
1547class RateLimitInfo:
1548 status: RateLimitStatus
1549 resets_at: int | None = None
1550 rate_limit_type: RateLimitType | None = None
1551 utilization: float | None = None
1552 overage_status: RateLimitStatus | None = None
1553 overage_resets_at: int | None = None
1554 overage_disabled_reason: str | None = None
1555 raw: dict[str, Any] = field(default_factory=dict)
1556```
1557
1558| Feld | Typ | Beschreibung |
1559| :------------------------ | :------------------------ | :--------------------------------------------------------------------------------------------------------------------------------- |
1560| `status` | `RateLimitStatus` | Aktueller Status. `"allowed_warning"` bedeutet, dass die Grenze näher rückt; `"rejected"` bedeutet, dass die Grenze erreicht wurde |
1561| `resets_at` | `int \| None` | Unix-Zeitstempel, wenn das Rate-Limit-Fenster zurückgesetzt wird |
1562| `rate_limit_type` | `RateLimitType \| None` | Welches Rate-Limit-Fenster gilt |
1563| `utilization` | `float \| None` | Anteil des Rate-Limits, das verbraucht wurde (0,0 bis 1,0) |
1564| `overage_status` | `RateLimitStatus \| None` | Status der Pay-as-you-go-Übernutzung, falls zutreffend |
1565| `overage_resets_at` | `int \| None` | Unix-Zeitstempel, wenn das Übernutzungs-Fenster zurückgesetzt wird |
1566| `overage_disabled_reason` | `str \| None` | Warum Übernutzung nicht verfügbar ist, wenn Status `"rejected"` ist |
1567| `raw` | `dict[str, Any]` | Vollständiges Rohdictionary von der CLI, einschließlich Felder, die oben nicht modelliert sind |
1568
1569### `TaskStartedMessage`
1570
1571Wird ausgegeben, wenn eine Hintergrundaufgabe startet. Eine Hintergrundaufgabe ist alles, was außerhalb der Hauptumdrehung verfolgt wird: ein backgroundierter Bash-Befehl, eine [Monitor](#monitor)-Überwachung, ein Subagent, der über das Agent-Tool erzeugt wird, oder ein Remote-Agent. Das Feld `task_type` sagt Ihnen, welches. Diese Benennung ist nicht verwandt mit der `Task`-zu-`Agent`-Tool-Umbenennung.
1572
1573```python theme={null}
1574@dataclass
1575class TaskStartedMessage(SystemMessage):
1576 task_id: str
1577 description: str
1578 uuid: str
1579 session_id: str
1580 tool_use_id: str | None = None
1581 task_type: str | None = None
1582```
1583
1584| Feld | Typ | Beschreibung |
1585| :------------ | :------------ | :------------------------------------------------------------------------------------------------------------------------------------- |
1586| `task_id` | `str` | Eindeutige Kennung für die Aufgabe |
1587| `description` | `str` | Beschreibung der Aufgabe |
1588| `uuid` | `str` | Eindeutige Nachrichtenkennung |
1589| `session_id` | `str` | Sitzungskennung |
1590| `tool_use_id` | `str \| None` | Zugeordnete Tool-Use-ID |
1591| `task_type` | `str \| None` | Welche Art von Hintergrundaufgabe: `"local_bash"` für Background Bash und Monitor-Überwachungen, `"local_agent"` oder `"remote_agent"` |
1592
1593### `TaskUsage`
1594
1595Token- und Timing-Daten für eine Hintergrundaufgabe.
1596
1597```python theme={null}
1598class TaskUsage(TypedDict):
1599 total_tokens: int
1600 tool_uses: int
1601 duration_ms: int
1602```
1603
1604### `TaskProgressMessage`
1605
1606Wird regelmäßig mit Fortschrittsaktualisierungen für eine laufende Hintergrundaufgabe ausgegeben.
1607
1608```python theme={null}
1609@dataclass
1610class TaskProgressMessage(SystemMessage):
1611 task_id: str
1612 description: str
1613 usage: TaskUsage
1614 uuid: str
1615 session_id: str
1616 tool_use_id: str | None = None
1617 last_tool_name: str | None = None
1618```
1619
1620| Feld | Typ | Beschreibung |
1621| :--------------- | :------------ | :---------------------------------------------------- |
1622| `task_id` | `str` | Eindeutige Kennung für die Aufgabe |
1623| `description` | `str` | Aktuelle Statusbeschreibung |
1624| `usage` | `TaskUsage` | Token-Nutzung für diese Aufgabe bisher |
1625| `uuid` | `str` | Eindeutige Nachrichtenkennung |
1626| `session_id` | `str` | Sitzungskennung |
1627| `tool_use_id` | `str \| None` | Zugeordnete Tool-Use-ID |
1628| `last_tool_name` | `str \| None` | Name des letzten Tools, das die Aufgabe verwendet hat |
1629
1630### `TaskNotificationMessage`
1631
1632Wird ausgegeben, wenn eine Hintergrundaufgabe abgeschlossen, fehlgeschlagen oder gestoppt wird. Hintergrundaufgaben umfassen `run_in_background`-Bash-Befehle, Monitor-Überwachungen und Background-Subagenten.
1633
1634```python theme={null}
1635@dataclass
1636class TaskNotificationMessage(SystemMessage):
1637 task_id: str
1638 status: TaskNotificationStatus # "completed" | "failed" | "stopped"
1639 output_file: str
1640 summary: str
1641 uuid: str
1642 session_id: str
1643 tool_use_id: str | None = None
1644 usage: TaskUsage | None = None
1645```
1646
1647| Feld | Typ | Beschreibung |
1648| :------------ | :----------------------- | :--------------------------------------------------- |
1649| `task_id` | `str` | Eindeutige Kennung für die Aufgabe |
1650| `status` | `TaskNotificationStatus` | Einer von `"completed"`, `"failed"` oder `"stopped"` |
1651| `output_file` | `str` | Pfad zur Aufgabenausgabedatei |
1652| `summary` | `str` | Zusammenfassung des Aufgabenergebnisses |
1653| `uuid` | `str` | Eindeutige Nachrichtenkennung |
1654| `session_id` | `str` | Sitzungskennung |
1655| `tool_use_id` | `str \| None` | Zugeordnete Tool-Use-ID |
1656| `usage` | `TaskUsage \| None` | Endgültige Token-Nutzung für die Aufgabe |
1657
1658## Inhaltsblock-Typen
1659
1660### `ContentBlock`
1661
1662Union-Typ aller Inhaltsblöcke.
1663
1664```python theme={null}
1665ContentBlock = TextBlock | ThinkingBlock | ToolUseBlock | ToolResultBlock
1666```
1667
1668### `TextBlock`
1669
1670Text-Inhaltsblock.
1671
1672```python theme={null}
1673@dataclass
1674class TextBlock:
1675 text: str
1676```
1677
1678### `ThinkingBlock`
1679
1680Thinking-Inhaltsblock (für Modelle mit Thinking-Fähigkeit).
1681
1682```python theme={null}
1683@dataclass
1684class ThinkingBlock:
1685 thinking: str
1686 signature: str
1687```
1688
1689### `ToolUseBlock`
1690
1691Tool-Use-Anfrage-Block.
1692
1693```python theme={null}
1694@dataclass
1695class ToolUseBlock:
1696 id: str
1697 name: str
1698 input: dict[str, Any]
1699```
1700
1701### `ToolResultBlock`
1702
1703Tool-Ausführungs-Ergebnis-Block.
1704
1705```python theme={null}
1706@dataclass
1707class ToolResultBlock:
1708 tool_use_id: str
1709 content: str | list[dict[str, Any]] | None = None
1710 is_error: bool | None = None
1711```
1712
1713## Fehlertypen
1714
1715### `ClaudeSDKError`
1716
1717Basis-Ausnahmeklasse für alle SDK-Fehler.
1718
1719```python theme={null}
1720class ClaudeSDKError(Exception):
1721 """Base error for Claude SDK."""
1722```
1723
1724### `CLINotFoundError`
1725
1726Wird ausgelöst, wenn Claude Code CLI nicht installiert oder nicht gefunden ist.
1727
1728```python theme={null}
1729class CLINotFoundError(CLIConnectionError):
1730 def __init__(
1731 self, message: str = "Claude Code not found", cli_path: str | None = None
1732 ):
1733 """
1734 Args:
1735 message: Error message (default: "Claude Code not found")
1736 cli_path: Optional path to the CLI that was not found
1737 """
1738```
1739
1740### `CLIConnectionError`
1741
1742Wird ausgelöst, wenn die Verbindung zu Claude Code fehlschlägt.
1743
1744```python theme={null}
1745class CLIConnectionError(ClaudeSDKError):
1746 """Failed to connect to Claude Code."""
1747```
1748
1749### `ProcessError`
1750
1751Wird ausgelöst, wenn der Claude Code-Prozess fehlschlägt.
1752
1753```python theme={null}
1754class ProcessError(ClaudeSDKError):
1755 def __init__(
1756 self, message: str, exit_code: int | None = None, stderr: str | None = None
1757 ):
1758 self.exit_code = exit_code
1759 self.stderr = stderr
1760```
1761
1762### `CLIJSONDecodeError`
1763
1764Wird ausgelöst, wenn JSON-Parsing fehlschlägt.
1765
1766```python theme={null}
1767class CLIJSONDecodeError(ClaudeSDKError):
1768 def __init__(self, line: str, original_error: Exception):
1769 """
1770 Args:
1771 line: The line that failed to parse
1772 original_error: The original JSON decode exception
1773 """
1774 self.line = line
1775 self.original_error = original_error
1776```
1777
1778## Hook-Typen
1779
1780Einen umfassenden Leitfaden zur Verwendung von Hooks mit Beispielen und häufigen Mustern finden Sie im [Hooks-Leitfaden](/de/agent-sdk/hooks).
1781
1782### `HookEvent`
1783
1784Unterstützte Hook-Ereignistypen.
1785
1786```python theme={null}
1787HookEvent = Literal[
1788 "PreToolUse", # Called before tool execution
1789 "PostToolUse", # Called after tool execution
1790 "PostToolUseFailure", # Called when a tool execution fails
1791 "UserPromptSubmit", # Called when user submits a prompt
1792 "Stop", # Called when stopping execution
1793 "SubagentStop", # Called when a subagent stops
1794 "PreCompact", # Called before message compaction
1795 "Notification", # Called for notification events
1796 "SubagentStart", # Called when a subagent starts
1797 "PermissionRequest", # Called when a permission decision is needed
1798]
1799```
1800
1801<Note>
1802 Das TypeScript SDK unterstützt zusätzliche Hook-Ereignisse, die in Python noch nicht verfügbar sind: `SessionStart`, `SessionEnd`, `Setup`, `TeammateIdle`, `TaskCompleted`, `ConfigChange`, `WorktreeCreate`, `WorktreeRemove` und `PostToolBatch`.
1803</Note>
1804
1805### `HookCallback`
1806
1807Typ-Definition für Hook-Callback-Funktionen.
1808
1809```python theme={null}
1810HookCallback = Callable[[HookInput, str | None, HookContext], Awaitable[HookJSONOutput]]
1811```
1812
1813Parameter:
1814
1815* `input`: Stark typisierte Hook-Eingabe mit diskriminierten Unions basierend auf `hook_event_name` (siehe [`HookInput`](#hook-input))
1816* `tool_use_id`: Optionale Tool-Use-Kennung (für Tool-bezogene Hooks)
1817* `context`: Hook-Kontext mit zusätzlichen Informationen
1818
1819Gibt ein [`HookJSONOutput`](#hook-json-output) zurück, das enthalten kann:
1820
1821* `decision`: `"block"`, um die Aktion zu blockieren
1822* `systemMessage`: System-Nachricht, die zum Transkript hinzugefügt werden soll
1823* `hookSpecificOutput`: Hook-spezifische Ausgabedaten
1824
1825### `HookContext`
1826
1827Kontextinformationen, die an Hook-Callbacks übergeben werden.
1828
1829```python theme={null}
1830class HookContext(TypedDict):
1831 signal: Any | None # Future: abort signal support
1832```
1833
1834### `HookMatcher`
1835
1836Konfiguration zum Abgleichen von Hooks mit bestimmten Ereignissen oder Tools.
1837
1838```python theme={null}
1839@dataclass
1840class HookMatcher:
1841 matcher: str | None = (
1842 None # Tool name or pattern to match (e.g., "Bash", "Write|Edit")
1843 )
1844 hooks: list[HookCallback] = field(
1845 default_factory=list
1846 ) # List of callbacks to execute
1847 timeout: float | None = (
1848 None # Timeout in seconds for all hooks in this matcher (default: 60)
1849 )
1850```
1851
1852### `HookInput`
1853
1854Union-Typ aller Hook-Eingabetypen. Der tatsächliche Typ hängt vom Feld `hook_event_name` ab.
1855
1856```python theme={null}
1857HookInput = (
1858 PreToolUseHookInput
1859 | PostToolUseHookInput
1860 | PostToolUseFailureHookInput
1861 | UserPromptSubmitHookInput
1862 | StopHookInput
1863 | SubagentStopHookInput
1864 | PreCompactHookInput
1865 | NotificationHookInput
1866 | SubagentStartHookInput
1867 | PermissionRequestHookInput
1868)
1869```
1870
1871### `BaseHookInput`
1872
1873Basis-Felder, die in allen Hook-Eingabetypen vorhanden sind.
1874
1875```python theme={null}
1876class BaseHookInput(TypedDict):
1877 session_id: str
1878 transcript_path: str
1879 cwd: str
1880 permission_mode: NotRequired[str]
1881```
1882
1883| Feld | Typ | Beschreibung |
1884| :---------------- | :--------------- | :-------------------------------- |
1885| `session_id` | `str` | Aktuelle Sitzungskennung |
1886| `transcript_path` | `str` | Pfad zur Sitzungstranskript-Datei |
1887| `cwd` | `str` | Aktuelles Arbeitsverzeichnis |
1888| `permission_mode` | `str` (optional) | Aktueller Berechtigungsmodus |
1889
1890### `PreToolUseHookInput`
1891
1892Eingabedaten für `PreToolUse`-Hook-Ereignisse.
1893
1894```python theme={null}
1895class PreToolUseHookInput(BaseHookInput):
1896 hook_event_name: Literal["PreToolUse"]
1897 tool_name: str
1898 tool_input: dict[str, Any]
1899 tool_use_id: str
1900 agent_id: NotRequired[str]
1901 agent_type: NotRequired[str]
1902```
1903
1904| Feld | Typ | Beschreibung |
1905| :---------------- | :---------------------- | :------------------------------------------------------------------------------------- |
1906| `hook_event_name` | `Literal["PreToolUse"]` | Immer "PreToolUse" |
1907| `tool_name` | `str` | Name des Tools, das ausgeführt werden soll |
1908| `tool_input` | `dict[str, Any]` | Eingabeparameter für das Tool |
1909| `tool_use_id` | `str` | Eindeutige Kennung für diese Tool-Nutzung |
1910| `agent_id` | `str` (optional) | Subagenten-Kennung, vorhanden, wenn der Hook innerhalb eines Subagenten ausgelöst wird |
1911| `agent_type` | `str` (optional) | Subagenten-Typ, vorhanden, wenn der Hook innerhalb eines Subagenten ausgelöst wird |
1912
1913### `PostToolUseHookInput`
1914
1915Eingabedaten für `PostToolUse`-Hook-Ereignisse.
1916
1917```python theme={null}
1918class PostToolUseHookInput(BaseHookInput):
1919 hook_event_name: Literal["PostToolUse"]
1920 tool_name: str
1921 tool_input: dict[str, Any]
1922 tool_response: Any
1923 tool_use_id: str
1924 agent_id: NotRequired[str]
1925 agent_type: NotRequired[str]
1926```
1927
1928| Feld | Typ | Beschreibung |
1929| :---------------- | :----------------------- | :------------------------------------------------------------------------------------- |
1930| `hook_event_name` | `Literal["PostToolUse"]` | Immer "PostToolUse" |
1931| `tool_name` | `str` | Name des Tools, das ausgeführt wurde |
1932| `tool_input` | `dict[str, Any]` | Eingabeparameter, die verwendet wurden |
1933| `tool_response` | `Any` | Antwort aus der Tool-Ausführung |
1934| `tool_use_id` | `str` | Eindeutige Kennung für diese Tool-Nutzung |
1935| `agent_id` | `str` (optional) | Subagenten-Kennung, vorhanden, wenn der Hook innerhalb eines Subagenten ausgelöst wird |
1936| `agent_type` | `str` (optional) | Subagenten-Typ, vorhanden, wenn der Hook innerhalb eines Subagenten ausgelöst wird |
1937
1938### `PostToolUseFailureHookInput`
1939
1940Eingabedaten für `PostToolUseFailure`-Hook-Ereignisse. Wird aufgerufen, wenn eine Tool-Ausführung fehlschlägt.
1941
1942```python theme={null}
1943class PostToolUseFailureHookInput(BaseHookInput):
1944 hook_event_name: Literal["PostToolUseFailure"]
1945 tool_name: str
1946 tool_input: dict[str, Any]
1947 tool_use_id: str
1948 error: str
1949 is_interrupt: NotRequired[bool]
1950 agent_id: NotRequired[str]
1951 agent_type: NotRequired[str]
1952```
1953
1954| Feld | Typ | Beschreibung |
1955| :---------------- | :------------------------------ | :------------------------------------------------------------------------------------- |
1956| `hook_event_name` | `Literal["PostToolUseFailure"]` | Immer "PostToolUseFailure" |
1957| `tool_name` | `str` | Name des Tools, das fehlgeschlagen ist |
1958| `tool_input` | `dict[str, Any]` | Eingabeparameter, die verwendet wurden |
1959| `tool_use_id` | `str` | Eindeutige Kennung für diese Tool-Nutzung |
1960| `error` | `str` | Fehlermeldung aus der fehlgeschlagenen Ausführung |
1961| `is_interrupt` | `bool` (optional) | Ob der Fehler durch eine Unterbrechung verursacht wurde |
1962| `agent_id` | `str` (optional) | Subagenten-Kennung, vorhanden, wenn der Hook innerhalb eines Subagenten ausgelöst wird |
1963| `agent_type` | `str` (optional) | Subagenten-Typ, vorhanden, wenn der Hook innerhalb eines Subagenten ausgelöst wird |
1964
1965### `UserPromptSubmitHookInput`
1966
1967Eingabedaten für `UserPromptSubmit`-Hook-Ereignisse.
1968
1969```python theme={null}
1970class UserPromptSubmitHookInput(BaseHookInput):
1971 hook_event_name: Literal["UserPromptSubmit"]
1972 prompt: str
1973```
1974
1975| Feld | Typ | Beschreibung |
1976| :---------------- | :---------------------------- | :----------------------------------------- |
1977| `hook_event_name` | `Literal["UserPromptSubmit"]` | Immer "UserPromptSubmit" |
1978| `prompt` | `str` | Die vom Benutzer eingereichte Aufforderung |
1979
1980### `StopHookInput`
1981
1982Eingabedaten für `Stop`-Hook-Ereignisse.
1983
1984```python theme={null}
1985class StopHookInput(BaseHookInput):
1986 hook_event_name: Literal["Stop"]
1987 stop_hook_active: bool
1988```
1989
1990| Feld | Typ | Beschreibung |
1991| :----------------- | :---------------- | :------------------------- |
1992| `hook_event_name` | `Literal["Stop"]` | Immer "Stop" |
1993| `stop_hook_active` | `bool` | Ob der Stop-Hook aktiv ist |
1994
1995### `SubagentStopHookInput`
1996
1997Eingabedaten für `SubagentStop`-Hook-Ereignisse.
1998
1999```python theme={null}
2000class SubagentStopHookInput(BaseHookInput):
2001 hook_event_name: Literal["SubagentStop"]
2002 stop_hook_active: bool
2003 agent_id: str
2004 agent_transcript_path: str
2005 agent_type: str
2006```
2007
2008| Feld | Typ | Beschreibung |
2009| :---------------------- | :------------------------ | :--------------------------------------- |
2010| `hook_event_name` | `Literal["SubagentStop"]` | Immer "SubagentStop" |
2011| `stop_hook_active` | `bool` | Ob der Stop-Hook aktiv ist |
2012| `agent_id` | `str` | Eindeutige Kennung für den Subagenten |
2013| `agent_transcript_path` | `str` | Pfad zur Transkript-Datei des Subagenten |
2014| `agent_type` | `str` | Typ des Subagenten |
2015
2016### `PreCompactHookInput`
2017
2018Eingabedaten für `PreCompact`-Hook-Ereignisse.
2019
2020```python theme={null}
2021class PreCompactHookInput(BaseHookInput):
2022 hook_event_name: Literal["PreCompact"]
2023 trigger: Literal["manual", "auto"]
2024 custom_instructions: str | None
2025```
2026
2027| Feld | Typ | Beschreibung |
2028| :-------------------- | :-------------------------- | :--------------------------------------------------- |
2029| `hook_event_name` | `Literal["PreCompact"]` | Immer "PreCompact" |
2030| `trigger` | `Literal["manual", "auto"]` | Was die Komprimierung ausgelöst hat |
2031| `custom_instructions` | `str \| None` | Benutzerdefinierte Anweisungen für die Komprimierung |
2032
2033### `NotificationHookInput`
2034
2035Eingabedaten für `Notification`-Hook-Ereignisse.
2036
2037```python theme={null}
2038class NotificationHookInput(BaseHookInput):
2039 hook_event_name: Literal["Notification"]
2040 message: str
2041 title: NotRequired[str]
2042 notification_type: str
2043```
2044
2045| Feld | Typ | Beschreibung |
2046| :------------------ | :------------------------ | :--------------------------------- |
2047| `hook_event_name` | `Literal["Notification"]` | Immer "Notification" |
2048| `message` | `str` | Benachrichtigungsnachrichteninhalt |
2049| `title` | `str` (optional) | Benachrichtigungstitel |
2050| `notification_type` | `str` | Benachrichtigungstyp |
2051
2052### `SubagentStartHookInput`
2053
2054Eingabedaten für `SubagentStart`-Hook-Ereignisse.
2055
2056```python theme={null}
2057class SubagentStartHookInput(BaseHookInput):
2058 hook_event_name: Literal["SubagentStart"]
2059 agent_id: str
2060 agent_type: str
2061```
2062
2063| Feld | Typ | Beschreibung |
2064| :---------------- | :------------------------- | :------------------------------------ |
2065| `hook_event_name` | `Literal["SubagentStart"]` | Immer "SubagentStart" |
2066| `agent_id` | `str` | Eindeutige Kennung für den Subagenten |
2067| `agent_type` | `str` | Typ des Subagenten |
2068
2069### `PermissionRequestHookInput`
2070
2071Eingabedaten für `PermissionRequest`-Hook-Ereignisse. Ermöglicht Hooks, Berechtigungsentscheidungen programmgesteuert zu handhaben.
2072
2073```python theme={null}
2074class PermissionRequestHookInput(BaseHookInput):
2075 hook_event_name: Literal["PermissionRequest"]
2076 tool_name: str
2077 tool_input: dict[str, Any]
2078 permission_suggestions: NotRequired[list[Any]]
2079```
2080
2081| Feld | Typ | Beschreibung |
2082| :----------------------- | :----------------------------- | :------------------------------------------------------- |
2083| `hook_event_name` | `Literal["PermissionRequest"]` | Immer "PermissionRequest" |
2084| `tool_name` | `str` | Name des Tools, das Berechtigung anfordert |
2085| `tool_input` | `dict[str, Any]` | Eingabeparameter für das Tool |
2086| `permission_suggestions` | `list[Any]` (optional) | Vorgeschlagene Berechtigungsaktualisierungen von der CLI |
2087
2088### `HookJSONOutput`
2089
2090Union-Typ für Hook-Callback-Rückgabewerte.
2091
2092```python theme={null}
2093HookJSONOutput = AsyncHookJSONOutput | SyncHookJSONOutput
2094```
2095
2096#### `SyncHookJSONOutput`
2097
2098Synchrone Hook-Ausgabe mit Kontroll- und Entscheidungsfeldern.
2099
2100```python theme={null}
2101class SyncHookJSONOutput(TypedDict):
2102 # Control fields
2103 continue_: NotRequired[bool] # Whether to proceed (default: True)
2104 suppressOutput: NotRequired[bool] # Hide stdout from transcript
2105 stopReason: NotRequired[str] # Message when continue is False
2106
2107 # Decision fields
2108 decision: NotRequired[Literal["block"]]
2109 systemMessage: NotRequired[str] # Warning message for user
2110 reason: NotRequired[str] # Feedback for Claude
2111
2112 # Hook-specific output
2113 hookSpecificOutput: NotRequired[HookSpecificOutput]
2114```
2115
2116<Note>
2117 Verwenden Sie `continue_` (mit Unterstrich) im Python-Code. Es wird automatisch in `continue` konvertiert, wenn es an die CLI gesendet wird.
2118</Note>
2119
2120#### `HookSpecificOutput`
2121
2122Ein `TypedDict`, das den Hook-Ereignisnamen und ereignisspezifische Felder enthält. Die Form hängt vom `hookEventName`-Wert ab. Vollständige Details zu verfügbaren Feldern pro Hook-Ereignis finden Sie unter [Ausführung mit Hooks kontrollieren](/de/agent-sdk/hooks#outputs).
2123
2124Eine diskriminierte Union von ereignisspezifischen Ausgabetypen. Das Feld `hookEventName` bestimmt, welche Felder gültig sind.
2125
2126```python theme={null}
2127class PreToolUseHookSpecificOutput(TypedDict):
2128 hookEventName: Literal["PreToolUse"]
2129 permissionDecision: NotRequired[Literal["allow", "deny", "ask"]]
2130 permissionDecisionReason: NotRequired[str]
2131 updatedInput: NotRequired[dict[str, Any]]
2132 additionalContext: NotRequired[str]
2133
2134
2135class PostToolUseHookSpecificOutput(TypedDict):
2136 hookEventName: Literal["PostToolUse"]
2137 additionalContext: NotRequired[str]
2138 updatedMCPToolOutput: NotRequired[Any]
2139
2140
2141class PostToolUseFailureHookSpecificOutput(TypedDict):
2142 hookEventName: Literal["PostToolUseFailure"]
2143 additionalContext: NotRequired[str]
2144
2145
2146class UserPromptSubmitHookSpecificOutput(TypedDict):
2147 hookEventName: Literal["UserPromptSubmit"]
2148 additionalContext: NotRequired[str]
2149
2150
2151class NotificationHookSpecificOutput(TypedDict):
2152 hookEventName: Literal["Notification"]
2153 additionalContext: NotRequired[str]
2154
2155
2156class SubagentStartHookSpecificOutput(TypedDict):
2157 hookEventName: Literal["SubagentStart"]
2158 additionalContext: NotRequired[str]
2159
2160
2161class PermissionRequestHookSpecificOutput(TypedDict):
2162 hookEventName: Literal["PermissionRequest"]
2163 decision: dict[str, Any]
2164
2165
2166HookSpecificOutput = (
2167 PreToolUseHookSpecificOutput
2168 | PostToolUseHookSpecificOutput
2169 | PostToolUseFailureHookSpecificOutput
2170 | UserPromptSubmitHookSpecificOutput
2171 | NotificationHookSpecificOutput
2172 | SubagentStartHookSpecificOutput
2173 | PermissionRequestHookSpecificOutput
2174)
2175```
2176
2177#### `AsyncHookJSONOutput`
2178
2179Asynchrone Hook-Ausgabe, die Hook-Ausführung aufschiebt.
2180
2181```python theme={null}
2182class AsyncHookJSONOutput(TypedDict):
2183 async_: Literal[True] # Set to True to defer execution
2184 asyncTimeout: NotRequired[int] # Timeout in milliseconds
2185```
2186
2187<Note>
2188 Verwenden Sie `async_` (mit Unterstrich) im Python-Code. Es wird automatisch in `async` konvertiert, wenn es an die CLI gesendet wird.
2189</Note>
2190
2191### Hook-Verwendungsbeispiel
2192
2193Dieses Beispiel registriert zwei Hooks: einen, der gefährliche Bash-Befehle wie `rm -rf /` blockiert, und einen anderen, der alle Tool-Nutzung für Auditing protokolliert. Der Sicherheits-Hook wird nur auf Bash-Befehle ausgeführt (über den `matcher`), während der Logging-Hook auf alle Tools angewendet wird.
2194
2195```python theme={null}
2196from claude_agent_sdk import query, ClaudeAgentOptions, HookMatcher, HookContext
2197from typing import Any
2198
2199
2200async def validate_bash_command(
2201 input_data: dict[str, Any], tool_use_id: str | None, context: HookContext
2202) -> dict[str, Any]:
2203 """Validate and potentially block dangerous bash commands."""
2204 if input_data["tool_name"] == "Bash":
2205 command = input_data["tool_input"].get("command", "")
2206 if "rm -rf /" in command:
2207 return {
2208 "hookSpecificOutput": {
2209 "hookEventName": "PreToolUse",
2210 "permissionDecision": "deny",
2211 "permissionDecisionReason": "Dangerous command blocked",
2212 }
2213 }
2214 return {}
2215
2216
2217async def log_tool_use(
2218 input_data: dict[str, Any], tool_use_id: str | None, context: HookContext
2219) -> dict[str, Any]:
2220 """Log all tool usage for auditing."""
2221 print(f"Tool used: {input_data.get('tool_name')}")
2222 return {}
2223
2224
2225options = ClaudeAgentOptions(
2226 hooks={
2227 "PreToolUse": [
2228 HookMatcher(
2229 matcher="Bash", hooks=[validate_bash_command], timeout=120
2230 ), # 2 min for validation
2231 HookMatcher(
2232 hooks=[log_tool_use]
2233 ), # Applies to all tools (default 60s timeout)
2234 ],
2235 "PostToolUse": [HookMatcher(hooks=[log_tool_use])],
2236 }
2237)
2238
2239async for message in query(prompt="Analyze this codebase", options=options):
2240 print(message)
2241```
2242
2243## Tool-Eingabe-/Ausgabetypen
2244
2245Dokumentation von Eingabe-/Ausgabeschemas für alle integrierten Claude Code-Tools. Während das Python SDK diese nicht als Typen exportiert, stellen sie die Struktur von Tool-Eingaben und -Ausgaben in Nachrichten dar.
2246
2247### Agent
2248
2249**Tool-Name:** `Agent` (früher `Task`, das immer noch als Alias akzeptiert wird)
2250
2251**Eingabe:**
2252
2253```python theme={null}
2254{
2255 "description": str, # A short (3-5 word) description of the task
2256 "prompt": str, # The task for the agent to perform
2257 "subagent_type": str, # The type of specialized agent to use
2258}
2259```
2260
2261**Ausgabe:**
2262
2263```python theme={null}
2264{
2265 "result": str, # Final result from the subagent
2266 "usage": dict | None, # Token usage statistics
2267 "total_cost_usd": float | None, # Estimated total cost in USD
2268 "duration_ms": int | None, # Execution duration in milliseconds
2269}
2270```
2271
2272### AskUserQuestion
2273
2274**Tool-Name:** `AskUserQuestion`
2275
2276Stellt dem Benutzer während der Ausführung Klärungsfragen. Siehe [Genehmigungen und Benutzereingaben handhaben](/de/agent-sdk/user-input#handle-clarifying-questions) für Verwendungsdetails.
2277
2278**Eingabe:**
2279
2280```python theme={null}
2281{
2282 "questions": [ # Questions to ask the user (1-4 questions)
2283 {
2284 "question": str, # The complete question to ask the user
2285 "header": str, # Very short label displayed as a chip/tag (max 12 chars)
2286 "options": [ # The available choices (2-4 options)
2287 {
2288 "label": str, # Display text for this option (1-5 words)
2289 "description": str, # Explanation of what this option means
2290 }
2291 ],
2292 "multiSelect": bool, # Set to true to allow multiple selections
2293 }
2294 ],
2295 "answers": dict | None, # User answers populated by the permission system
2296}
2297```
2298
2299**Ausgabe:**
2300
2301```python theme={null}
2302{
2303 "questions": [ # The questions that were asked
2304 {
2305 "question": str,
2306 "header": str,
2307 "options": [{"label": str, "description": str}],
2308 "multiSelect": bool,
2309 }
2310 ],
2311 "answers": dict[str, str], # Maps question text to answer string
2312 # Multi-select answers are comma-separated
2313}
2314```
2315
2316### Bash
2317
2318**Tool-Name:** `Bash`
2319
2320**Eingabe:**
2321
2322```python theme={null}
2323{
2324 "command": str, # The command to execute
2325 "timeout": int | None, # Optional timeout in milliseconds (max 600000)
2326 "description": str | None, # Clear, concise description (5-10 words)
2327 "run_in_background": bool | None, # Set to true to run in background
2328}
2329```
2330
2331**Ausgabe:**
2332
2333```python theme={null}
2334{
2335 "output": str, # Combined stdout and stderr output
2336 "exitCode": int, # Exit code of the command
2337 "killed": bool | None, # Whether command was killed due to timeout
2338 "shellId": str | None, # Shell ID for background processes
2339}
2340```
2341
2342### Monitor
2343
2344**Tool-Name:** `Monitor`
2345
2346Führt ein Background-Skript aus und liefert jede stdout-Zeile an Claude als Ereignis, damit es reagieren kann, ohne zu pollen. Monitor folgt den gleichen Berechtigungsregeln wie Bash. Siehe die [Monitor-Tool-Referenz](/de/tools-reference#monitor-tool) für Verhalten und Provider-Verfügbarkeit.
2347
2348**Eingabe:**
2349
2350```python theme={null}
2351{
2352 "command": str, # Shell script; each stdout line is an event, exit ends the watch
2353 "description": str, # Short description shown in notifications
2354 "timeout_ms": int | None, # Kill after this deadline (default 300000, max 3600000)
2355 "persistent": bool | None, # Run for the lifetime of the session; stop with TaskStop
2356}
2357```
2358
2359**Ausgabe:**
2360
2361```python theme={null}
2362{
2363 "taskId": str, # ID of the background monitor task
2364 "timeoutMs": int, # Timeout deadline in milliseconds (0 when persistent)
2365 "persistent": bool | None, # True when running until TaskStop or session end
2366}
2367```
2368
2369### Edit
2370
2371**Tool-Name:** `Edit`
2372
2373**Eingabe:**
2374
2375```python theme={null}
2376{
2377 "file_path": str, # The absolute path to the file to modify
2378 "old_string": str, # The text to replace
2379 "new_string": str, # The text to replace it with
2380 "replace_all": bool | None, # Replace all occurrences (default False)
2381}
2382```
2383
2384**Ausgabe:**
2385
2386```python theme={null}
2387{
2388 "message": str, # Confirmation message
2389 "replacements": int, # Number of replacements made
2390 "file_path": str, # File path that was edited
2391}
2392```
2393
2394### Read
2395
2396**Tool-Name:** `Read`
2397
2398**Eingabe:**
2399
2400```python theme={null}
2401{
2402 "file_path": str, # The absolute path to the file to read
2403 "offset": int | None, # The line number to start reading from
2404 "limit": int | None, # The number of lines to read
2405}
2406```
2407
2408**Ausgabe (Textdateien):**
2409
2410```python theme={null}
2411{
2412 "content": str, # File contents with line numbers
2413 "total_lines": int, # Total number of lines in file
2414 "lines_returned": int, # Lines actually returned
2415}
2416```
2417
2418**Ausgabe (Bilder):**
2419
2420```python theme={null}
2421{
2422 "image": str, # Base64 encoded image data
2423 "mime_type": str, # Image MIME type
2424 "file_size": int, # File size in bytes
2425}
2426```
2427
2428### Write
2429
2430**Tool-Name:** `Write`
2431
2432**Eingabe:**
2433
2434```python theme={null}
2435{
2436 "file_path": str, # The absolute path to the file to write
2437 "content": str, # The content to write to the file
2438}
2439```
2440
2441**Ausgabe:**
2442
2443```python theme={null}
2444{
2445 "message": str, # Success message
2446 "bytes_written": int, # Number of bytes written
2447 "file_path": str, # File path that was written
2448}
2449```
2450
2451### Glob
2452
2453**Tool-Name:** `Glob`
2454
2455**Eingabe:**
2456
2457```python theme={null}
2458{
2459 "pattern": str, # The glob pattern to match files against
2460 "path": str | None, # The directory to search in (defaults to cwd)
2461}
2462```
2463
2464**Ausgabe:**
2465
2466```python theme={null}
2467{
2468 "matches": list[str], # Array of matching file paths
2469 "count": int, # Number of matches found
2470 "search_path": str, # Search directory used
2471}
2472```
2473
2474### Grep
2475
2476**Tool-Name:** `Grep`
2477
2478**Eingabe:**
2479
2480```python theme={null}
2481{
2482 "pattern": str, # The regular expression pattern
2483 "path": str | None, # File or directory to search in
2484 "glob": str | None, # Glob pattern to filter files
2485 "type": str | None, # File type to search
2486 "output_mode": str | None, # "content", "files_with_matches", or "count"
2487 "-i": bool | None, # Case insensitive search
2488 "-n": bool | None, # Show line numbers
2489 "-B": int | None, # Lines to show before each match
2490 "-A": int | None, # Lines to show after each match
2491 "-C": int | None, # Lines to show before and after
2492 "head_limit": int | None, # Limit output to first N lines/entries
2493 "multiline": bool | None, # Enable multiline mode
2494}
2495```
2496
2497**Ausgabe (content-Modus):**
2498
2499```python theme={null}
2500{
2501 "matches": [
2502 {
2503 "file": str,
2504 "line_number": int | None,
2505 "line": str,
2506 "before_context": list[str] | None,
2507 "after_context": list[str] | None,
2508 }
2509 ],
2510 "total_matches": int,
2511}
2512```
2513
2514**Ausgabe (files\_with\_matches-Modus):**
2515
2516```python theme={null}
2517{
2518 "files": list[str], # Files containing matches
2519 "count": int, # Number of files with matches
2520}
2521```
2522
2523### NotebookEdit
2524
2525**Tool-Name:** `NotebookEdit`
2526
2527**Eingabe:**
2528
2529```python theme={null}
2530{
2531 "notebook_path": str, # Absolute path to the Jupyter notebook
2532 "cell_id": str | None, # The ID of the cell to edit
2533 "new_source": str, # The new source for the cell
2534 "cell_type": "code" | "markdown" | None, # The type of the cell
2535 "edit_mode": "replace" | "insert" | "delete" | None, # Edit operation type
2536}
2537```
2538
2539**Ausgabe:**
2540
2541```python theme={null}
2542{
2543 "message": str, # Success message
2544 "edit_type": "replaced" | "inserted" | "deleted", # Type of edit performed
2545 "cell_id": str | None, # Cell ID that was affected
2546 "total_cells": int, # Total cells in notebook after edit
2547}
2548```
2549
2550### WebFetch
2551
2552**Tool-Name:** `WebFetch`
2553
2554**Eingabe:**
2555
2556```python theme={null}
2557{
2558 "url": str, # The URL to fetch content from
2559 "prompt": str, # The prompt to run on the fetched content
2560}
2561```
2562
2563**Ausgabe:**
2564
2565```python theme={null}
2566{
2567 "response": str, # AI model's response to the prompt
2568 "url": str, # URL that was fetched
2569 "final_url": str | None, # Final URL after redirects
2570 "status_code": int | None, # HTTP status code
2571}
2572```
2573
2574### WebSearch
2575
2576**Tool-Name:** `WebSearch`
2577
2578**Eingabe:**
2579
2580```python theme={null}
2581{
2582 "query": str, # The search query to use
2583 "allowed_domains": list[str] | None, # Only include results from these domains
2584 "blocked_domains": list[str] | None, # Never include results from these domains
2585}
2586```
2587
2588**Ausgabe:**
2589
2590```python theme={null}
2591{
2592 "results": [{"title": str, "url": str, "snippet": str, "metadata": dict | None}],
2593 "total_results": int,
2594 "query": str,
2595}
2596```
2597
2598### TodoWrite
2599
2600**Tool-Name:** `TodoWrite`
2601
2602**Eingabe:**
2603
2604```python theme={null}
2605{
2606 "todos": [
2607 {
2608 "content": str, # The task description
2609 "status": "pending" | "in_progress" | "completed", # Task status
2610 "activeForm": str, # Active form of the description
2611 }
2612 ]
2613}
2614```
2615
2616**Ausgabe:**
2617
2618```python theme={null}
2619{
2620 "message": str, # Success message
2621 "stats": {"total": int, "pending": int, "in_progress": int, "completed": int},
2622}
2623```
2624
2625### BashOutput
2626
2627**Tool-Name:** `BashOutput`
2628
2629**Eingabe:**
2630
2631```python theme={null}
2632{
2633 "bash_id": str, # The ID of the background shell
2634 "filter": str | None, # Optional regex to filter output lines
2635}
2636```
2637
2638**Ausgabe:**
2639
2640```python theme={null}
2641{
2642 "output": str, # New output since last check
2643 "status": "running" | "completed" | "failed", # Current shell status
2644 "exitCode": int | None, # Exit code when completed
2645}
2646```
2647
2648### KillBash
2649
2650**Tool-Name:** `KillBash`
2651
2652**Eingabe:**
2653
2654```python theme={null}
2655{
2656 "shell_id": str # The ID of the background shell to kill
2657}
2658```
2659
2660**Ausgabe:**
2661
2662```python theme={null}
2663{
2664 "message": str, # Success message
2665 "shell_id": str, # ID of the killed shell
2666}
2667```
2668
2669### ExitPlanMode
2670
2671**Tool-Name:** `ExitPlanMode`
2672
2673**Eingabe:**
2674
2675```python theme={null}
2676{
2677 "plan": str # The plan to run by the user for approval
2678}
2679```
2680
2681**Ausgabe:**
2682
2683```python theme={null}
2684{
2685 "message": str, # Confirmation message
2686 "approved": bool | None, # Whether user approved the plan
2687}
2688```
2689
2690### ListMcpResources
2691
2692**Tool-Name:** `ListMcpResources`
2693
2694**Eingabe:**
2695
2696```python theme={null}
2697{
2698 "server": str | None # Optional server name to filter resources by
2699}
2700```
2701
2702**Ausgabe:**
2703
2704```python theme={null}
2705{
2706 "resources": [
2707 {
2708 "uri": str,
2709 "name": str,
2710 "description": str | None,
2711 "mimeType": str | None,
2712 "server": str,
2713 }
2714 ],
2715 "total": int,
2716}
2717```
2718
2719### ReadMcpResource
2720
2721**Tool-Name:** `ReadMcpResource`
2722
2723**Eingabe:**
2724
2725```python theme={null}
2726{
2727 "server": str, # The MCP server name
2728 "uri": str, # The resource URI to read
2729}
2730```
2731
2732**Ausgabe:**
2733
2734```python theme={null}
2735{
2736 "contents": [
2737 {"uri": str, "mimeType": str | None, "text": str | None, "blob": str | None}
2738 ],
2739 "server": str,
2740}
2741```
2742
2743## Erweiterte Funktionen mit ClaudeSDKClient
2744
2745### Erstellen einer kontinuierlichen Konversationsschnittstelle
2746
2747```python theme={null}
2748from claude_agent_sdk import (
2749 ClaudeSDKClient,
2750 ClaudeAgentOptions,
2751 AssistantMessage,
2752 TextBlock,
2753)
2754import asyncio
2755
2756
2757class ConversationSession:
2758 """Maintains a single conversation session with Claude."""
2759
2760 def __init__(self, options: ClaudeAgentOptions | None = None):
2761 self.client = ClaudeSDKClient(options)
2762 self.turn_count = 0
2763
2764 async def start(self):
2765 await self.client.connect()
2766 print("Starting conversation session. Claude will remember context.")
2767 print(
2768 "Commands: 'exit' to quit, 'interrupt' to stop current task, 'new' for new session"
2769 )
2770
2771 while True:
2772 user_input = input(f"\n[Turn {self.turn_count + 1}] You: ")
2773
2774 if user_input.lower() == "exit":
2775 break
2776 elif user_input.lower() == "interrupt":
2777 await self.client.interrupt()
2778 print("Task interrupted!")
2779 continue
2780 elif user_input.lower() == "new":
2781 # Disconnect and reconnect for a fresh session
2782 await self.client.disconnect()
2783 await self.client.connect()
2784 self.turn_count = 0
2785 print("Started new conversation session (previous context cleared)")
2786 continue
2787
2788 # Send message - the session retains all previous messages
2789 await self.client.query(user_input)
2790 self.turn_count += 1
2791
2792 # Process response
2793 print(f"[Turn {self.turn_count}] Claude: ", end="")
2794 async for message in self.client.receive_response():
2795 if isinstance(message, AssistantMessage):
2796 for block in message.content:
2797 if isinstance(block, TextBlock):
2798 print(block.text, end="")
2799 print() # New line after response
2800
2801 await self.client.disconnect()
2802 print(f"Conversation ended after {self.turn_count} turns.")
2803
2804
2805async def main():
2806 options = ClaudeAgentOptions(
2807 allowed_tools=["Read", "Write", "Bash"], permission_mode="acceptEdits"
2808 )
2809 session = ConversationSession(options)
2810 await session.start()
2811
2812
2813# Example conversation:
2814# Turn 1 - You: "Create a file called hello.py"
2815# Turn 1 - Claude: "I'll create a hello.py file for you..."
2816# Turn 2 - You: "What's in that file?"
2817# Turn 2 - Claude: "The hello.py file I just created contains..." (remembers!)
2818# Turn 3 - You: "Add a main function to it"
2819# Turn 3 - Claude: "I'll add a main function to hello.py..." (knows which file!)
2820
2821asyncio.run(main())
2822```
2823
2824### Verwendung von Hooks zur Verhaltensänderung
2825
2826```python theme={null}
2827from claude_agent_sdk import (
2828 ClaudeSDKClient,
2829 ClaudeAgentOptions,
2830 HookMatcher,
2831 HookContext,
2832)
2833import asyncio
2834from typing import Any
2835
2836
2837async def pre_tool_logger(
2838 input_data: dict[str, Any], tool_use_id: str | None, context: HookContext
2839) -> dict[str, Any]:
2840 """Log all tool usage before execution."""
2841 tool_name = input_data.get("tool_name", "unknown")
2842 print(f"[PRE-TOOL] About to use: {tool_name}")
2843
2844 # You can modify or block the tool execution here
2845 if tool_name == "Bash" and "rm -rf" in str(input_data.get("tool_input", {})):
2846 return {
2847 "hookSpecificOutput": {
2848 "hookEventName": "PreToolUse",
2849 "permissionDecision": "deny",
2850 "permissionDecisionReason": "Dangerous command blocked",
2851 }
2852 }
2853 return {}
2854
2855
2856async def post_tool_logger(
2857 input_data: dict[str, Any], tool_use_id: str | None, context: HookContext
2858) -> dict[str, Any]:
2859 """Log results after tool execution."""
2860 tool_name = input_data.get("tool_name", "unknown")
2861 print(f"[POST-TOOL] Completed: {tool_name}")
2862 return {}
2863
2864
2865async def user_prompt_modifier(
2866 input_data: dict[str, Any], tool_use_id: str | None, context: HookContext
2867) -> dict[str, Any]:
2868 """Add context to user prompts."""
2869 original_prompt = input_data.get("prompt", "")
2870
2871 # Add a timestamp as additional context for Claude to see
2872 from datetime import datetime
2873
2874 timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
2875
2876 return {
2877 "hookSpecificOutput": {
2878 "hookEventName": "UserPromptSubmit",
2879 "additionalContext": f"[Submitted at {timestamp}] Original prompt: {original_prompt}",
2880 }
2881 }
2882
2883
2884async def main():
2885 options = ClaudeAgentOptions(
2886 hooks={
2887 "PreToolUse": [
2888 HookMatcher(hooks=[pre_tool_logger]),
2889 HookMatcher(matcher="Bash", hooks=[pre_tool_logger]),
2890 ],
2891 "PostToolUse": [HookMatcher(hooks=[post_tool_logger])],
2892 "UserPromptSubmit": [HookMatcher(hooks=[user_prompt_modifier])],
2893 },
2894 allowed_tools=["Read", "Write", "Bash"],
2895 )
2896
2897 async with ClaudeSDKClient(options=options) as client:
2898 await client.query("List files in current directory")
2899
2900 async for message in client.receive_response():
2901 # Hooks will automatically log tool usage
2902 pass
2903
2904
2905asyncio.run(main())
2906```
2907
2908### Echtzeit-Fortschrittsüberwachung
2909
2910```python theme={null}
2911from claude_agent_sdk import (
2912 ClaudeSDKClient,
2913 ClaudeAgentOptions,
2914 AssistantMessage,
2915 ToolUseBlock,
2916 ToolResultBlock,
2917 TextBlock,
2918)
2919import asyncio
2920
2921
2922async def monitor_progress():
2923 options = ClaudeAgentOptions(
2924 allowed_tools=["Write", "Bash"], permission_mode="acceptEdits"
2925 )
2926
2927 async with ClaudeSDKClient(options=options) as client:
2928 await client.query("Create 5 Python files with different sorting algorithms")
2929
2930 # Monitor progress in real-time
2931 async for message in client.receive_response():
2932 if isinstance(message, AssistantMessage):
2933 for block in message.content:
2934 if isinstance(block, ToolUseBlock):
2935 if block.name == "Write":
2936 file_path = block.input.get("file_path", "")
2937 print(f"Creating: {file_path}")
2938 elif isinstance(block, ToolResultBlock):
2939 print("Completed tool execution")
2940 elif isinstance(block, TextBlock):
2941 print(f"Claude says: {block.text[:100]}...")
2942
2943 print("Task completed!")
2944
2945
2946asyncio.run(monitor_progress())
2947```
2948
2949## Beispielverwendung
2950
2951### Grundlegende Dateivorgänge (mit query)
2952
2953```python theme={null}
2954from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, ToolUseBlock
2955import asyncio
2956
2957
2958async def create_project():
2959 options = ClaudeAgentOptions(
2960 allowed_tools=["Read", "Write", "Bash"],
2961 permission_mode="acceptEdits",
2962 cwd="/home/user/project",
2963 )
2964
2965 async for message in query(
2966 prompt="Create a Python project structure with setup.py", options=options
2967 ):
2968 if isinstance(message, AssistantMessage):
2969 for block in message.content:
2970 if isinstance(block, ToolUseBlock):
2971 print(f"Using tool: {block.name}")
2972
2973
2974asyncio.run(create_project())
2975```
2976
2977### Fehlerbehandlung
2978
2979```python theme={null}
2980from claude_agent_sdk import query, CLINotFoundError, ProcessError, CLIJSONDecodeError
2981
2982try:
2983 async for message in query(prompt="Hello"):
2984 print(message)
2985except CLINotFoundError:
2986 print(
2987 "Claude Code CLI not found. Try reinstalling: pip install --force-reinstall claude-agent-sdk"
2988 )
2989except ProcessError as e:
2990 print(f"Process failed with exit code: {e.exit_code}")
2991except CLIJSONDecodeError as e:
2992 print(f"Failed to parse response: {e}")
2993```
2994
2995### Streaming-Modus mit Client
2996
2997```python theme={null}
2998from claude_agent_sdk import ClaudeSDKClient
2999import asyncio
3000
3001
3002async def interactive_session():
3003 async with ClaudeSDKClient() as client:
3004 # Send initial message
3005 await client.query("What's the weather like?")
3006
3007 # Process responses
3008 async for msg in client.receive_response():
3009 print(msg)
3010
3011 # Send follow-up
3012 await client.query("Tell me more about that")
3013
3014 # Process follow-up response
3015 async for msg in client.receive_response():
3016 print(msg)
3017
3018
3019asyncio.run(interactive_session())
3020```
3021
3022### Verwendung benutzerdefinierter Tools mit ClaudeSDKClient
3023
3024```python theme={null}
3025from claude_agent_sdk import (
3026 ClaudeSDKClient,
3027 ClaudeAgentOptions,
3028 tool,
3029 create_sdk_mcp_server,
3030 AssistantMessage,
3031 TextBlock,
3032)
3033import asyncio
3034from typing import Any
3035
3036
3037# Define custom tools with @tool decorator
3038@tool("calculate", "Perform mathematical calculations", {"expression": str})
3039async def calculate(args: dict[str, Any]) -> dict[str, Any]:
3040 try:
3041 result = eval(args["expression"], {"__builtins__": {}})
3042 return {"content": [{"type": "text", "text": f"Result: {result}"}]}
3043 except Exception as e:
3044 return {
3045 "content": [{"type": "text", "text": f"Error: {str(e)}"}],
3046 "is_error": True,
3047 }
3048
3049
3050@tool("get_time", "Get current time", {})
3051async def get_time(args: dict[str, Any]) -> dict[str, Any]:
3052 from datetime import datetime
3053
3054 current_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
3055 return {"content": [{"type": "text", "text": f"Current time: {current_time}"}]}
3056
3057
3058async def main():
3059 # Create SDK MCP server with custom tools
3060 my_server = create_sdk_mcp_server(
3061 name="utilities", version="1.0.0", tools=[calculate, get_time]
3062 )
3063
3064 # Configure options with the server
3065 options = ClaudeAgentOptions(
3066 mcp_servers={"utils": my_server},
3067 allowed_tools=["mcp__utils__calculate", "mcp__utils__get_time"],
3068 )
3069
3070 # Use ClaudeSDKClient for interactive tool usage
3071 async with ClaudeSDKClient(options=options) as client:
3072 await client.query("What's 123 * 456?")
3073
3074 # Process calculation response
3075 async for message in client.receive_response():
3076 if isinstance(message, AssistantMessage):
3077 for block in message.content:
3078 if isinstance(block, TextBlock):
3079 print(f"Calculation: {block.text}")
3080
3081 # Follow up with time query
3082 await client.query("What time is it now?")
3083
3084 async for message in client.receive_response():
3085 if isinstance(message, AssistantMessage):
3086 for block in message.content:
3087 if isinstance(block, TextBlock):
3088 print(f"Time: {block.text}")
3089
3090
3091asyncio.run(main())
3092```
3093
3094## Sandbox-Konfiguration
3095
3096### `SandboxSettings`
3097
3098Konfiguration für das Sandbox-Verhalten. Verwenden Sie dies, um Command-Sandboxing zu aktivieren und Netzwerkbeschränkungen programmgesteuert zu konfigurieren.
3099
3100```python theme={null}
3101class SandboxSettings(TypedDict, total=False):
3102 enabled: bool
3103 autoAllowBashIfSandboxed: bool
3104 excludedCommands: list[str]
3105 allowUnsandboxedCommands: bool
3106 network: SandboxNetworkConfig
3107 ignoreViolations: SandboxIgnoreViolations
3108 enableWeakerNestedSandbox: bool
3109```
3110
3111| Eigenschaft | Typ | Standard | Beschreibung |
3112| :-------------------------- | :------------------------------------------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3113| `enabled` | `bool` | `False` | Aktivieren Sie den Sandbox-Modus für die Befehlsausführung |
3114| `autoAllowBashIfSandboxed` | `bool` | `True` | Genehmigen Sie Bash-Befehle automatisch, wenn die Sandbox aktiviert ist |
3115| `excludedCommands` | `list[str]` | `[]` | Befehle, die immer Sandbox-Beschränkungen umgehen (z. B. `["docker"]`). Diese werden automatisch ohne Modellbeteiligung unsandboxed ausgeführt |
3116| `allowUnsandboxedCommands` | `bool` | `True` | Erlauben Sie dem Modell, die Ausführung von Befehlen außerhalb der Sandbox anzufordern. Wenn `True`, kann das Modell `dangerouslyDisableSandbox` in der Tool-Eingabe setzen, was auf das [Berechtigungssystem](#permissions-fallback-for-unsandboxed-commands) zurückfällt |
3117| `network` | [`SandboxNetworkConfig`](#sandbox-network-config) | `None` | Netzwerkspezifische Sandbox-Konfiguration |
3118| `ignoreViolations` | [`SandboxIgnoreViolations`](#sandbox-ignore-violations) | `None` | Konfigurieren Sie, welche Sandbox-Verstöße ignoriert werden sollen |
3119| `enableWeakerNestedSandbox` | `bool` | `False` | Aktivieren Sie eine schwächere verschachtelte Sandbox für Kompatibilität |
3120
3121#### Beispielverwendung
3122
3123```python theme={null}
3124from claude_agent_sdk import query, ClaudeAgentOptions, SandboxSettings
3125
3126sandbox_settings: SandboxSettings = {
3127 "enabled": True,
3128 "autoAllowBashIfSandboxed": True,
3129 "network": {"allowLocalBinding": True},
3130}
3131
3132async for message in query(
3133 prompt="Build and test my project",
3134 options=ClaudeAgentOptions(sandbox=sandbox_settings),
3135):
3136 print(message)
3137```
3138
3139<Warning>
3140 **Unix-Socket-Sicherheit**: Die Option `allowUnixSockets` kann Zugriff auf leistungsstarke Systemdienste gewähren. Zum Beispiel ermöglicht das Zulassen von `/var/run/docker.sock` effektiv vollständigen Host-Systemzugriff über die Docker-API und umgeht die Sandbox-Isolation. Erlauben Sie nur Unix-Sockets, die absolut notwendig sind, und verstehen Sie die Sicherheitsauswirkungen jedes einzelnen.
3141</Warning>
3142
3143### `SandboxNetworkConfig`
3144
3145Netzwerkspezifische Konfiguration für den Sandbox-Modus.
3146
3147```python theme={null}
3148class SandboxNetworkConfig(TypedDict, total=False):
3149 allowedDomains: list[str]
3150 deniedDomains: list[str]
3151 allowManagedDomainsOnly: bool
3152 allowUnixSockets: list[str]
3153 allowAllUnixSockets: bool
3154 allowLocalBinding: bool
3155 allowMachLookup: list[str]
3156 httpProxyPort: int
3157 socksProxyPort: int
3158```
3159
3160| Eigenschaft | Typ | Standard | Beschreibung |
3161| :------------------------ | :---------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3162| `allowedDomains` | `list[str]` | `[]` | Domänennamen, auf die Sandbox-Prozesse zugreifen können |
3163| `deniedDomains` | `list[str]` | `[]` | Domänennamen, auf die Sandbox-Prozesse nicht zugreifen können. Hat Vorrang vor `allowedDomains` |
3164| `allowManagedDomainsOnly` | `bool` | `False` | Nur verwaltete Einstellungen: Wenn in verwalteten Einstellungen gesetzt, ignorieren Sie `allowedDomains` aus nicht verwalteten Einstellungsquellen. Hat keine Auswirkung, wenn über SDK-Optionen gesetzt |
3165| `allowUnixSockets` | `list[str]` | `[]` | Unix-Socket-Pfade, auf die Prozesse zugreifen können (z. B. Docker-Socket) |
3166| `allowAllUnixSockets` | `bool` | `False` | Erlauben Sie Zugriff auf alle Unix-Sockets |
3167| `allowLocalBinding` | `bool` | `False` | Erlauben Sie Prozessen, sich an lokale Ports zu binden (z. B. für Dev-Server) |
3168| `allowMachLookup` | `list[str]` | `[]` | Nur macOS: XPC/Mach-Servicenamen zum Zulassen. Unterstützt ein nachfolgendes Platzhalterzeichen |
3169| `httpProxyPort` | `int` | `None` | HTTP-Proxy-Port für Netzwerkanfragen |
3170| `socksProxyPort` | `int` | `None` | SOCKS-Proxy-Port für Netzwerkanfragen |
3171
3172<Note>
3173 Der integrierte Sandbox-Proxy erzwingt die Netzwerk-Allowlist basierend auf dem angeforderten Hostnamen und beendet oder inspiziert keinen TLS-Verkehr, daher können Techniken wie [Domain Fronting](https://en.wikipedia.org/wiki/Domain_fronting) ihn möglicherweise umgehen. Siehe [Sandboxing-Sicherheitsbeschränkungen](/de/sandboxing#security-limitations) für Details und [Sichere Bereitstellung](/de/agent-sdk/secure-deployment#traffic-forwarding) für die Konfiguration eines TLS-terminierenden Proxys.
3174</Note>
3175
3176### `SandboxIgnoreViolations`
3177
3178Konfiguration zum Ignorieren bestimmter Sandbox-Verstöße.
3179
3180```python theme={null}
3181class SandboxIgnoreViolations(TypedDict, total=False):
3182 file: list[str]
3183 network: list[str]
3184```
3185
3186| Eigenschaft | Typ | Standard | Beschreibung |
3187| :---------- | :---------- | :------- | :--------------------------------------------------------- |
3188| `file` | `list[str]` | `[]` | Dateipfad-Muster, für die Verstöße ignoriert werden sollen |
3189| `network` | `list[str]` | `[]` | Netzwerkmuster, für die Verstöße ignoriert werden sollen |
3190
3191### Berechtigungen-Fallback für Unsandboxed-Befehle
3192
3193Wenn `allowUnsandboxedCommands` aktiviert ist, kann das Modell anfordern, Befehle außerhalb der Sandbox auszuführen, indem es `dangerouslyDisableSandbox: True` in der Tool-Eingabe setzt. Diese Anfragen fallen auf das bestehende Berechtigungssystem zurück, was bedeutet, dass Ihr `can_use_tool`-Handler aufgerufen wird, sodass Sie benutzerdefinierte Autorisierungslogik implementieren können.
3194
3195<Note>
3196 **`excludedCommands` vs `allowUnsandboxedCommands`:**
3197
3198 * `excludedCommands`: Eine statische Liste von Befehlen, die immer automatisch die Sandbox umgehen (z. B. `["docker"]`). Das Modell hat keine Kontrolle darüber.
3199 * `allowUnsandboxedCommands`: Ermöglicht dem Modell, zur Laufzeit zu entscheiden, ob es die Ausführung außerhalb der Sandbox anfordert, indem es `dangerouslyDisableSandbox: True` in der Tool-Eingabe setzt.
3200</Note>
3201
3202```python theme={null}
3203from claude_agent_sdk import (
3204 query,
3205 ClaudeAgentOptions,
3206 HookMatcher,
3207 PermissionResultAllow,
3208 PermissionResultDeny,
3209 ToolPermissionContext,
3210)
3211
3212
3213async def can_use_tool(
3214 tool: str, input: dict, context: ToolPermissionContext
3215) -> PermissionResultAllow | PermissionResultDeny:
3216 # Check if the model is requesting to bypass the sandbox
3217 if tool == "Bash" and input.get("dangerouslyDisableSandbox"):
3218 # The model is requesting to run this command outside the sandbox
3219 print(f"Unsandboxed command requested: {input.get('command')}")
3220
3221 if is_command_authorized(input.get("command")):
3222 return PermissionResultAllow()
3223 return PermissionResultDeny(
3224 message="Command not authorized for unsandboxed execution"
3225 )
3226 return PermissionResultAllow()
3227
3228
3229# Required: dummy hook keeps the stream open for can_use_tool
3230async def dummy_hook(input_data, tool_use_id, context):
3231 return {"continue_": True}
3232
3233
3234async def prompt_stream():
3235 yield {
3236 "type": "user",
3237 "message": {"role": "user", "content": "Deploy my application"},
3238 }
3239
3240
3241async def main():
3242 async for message in query(
3243 prompt=prompt_stream(),
3244 options=ClaudeAgentOptions(
3245 sandbox={
3246 "enabled": True,
3247 "allowUnsandboxedCommands": True, # Model can request unsandboxed execution
3248 },
3249 permission_mode="default",
3250 can_use_tool=can_use_tool,
3251 hooks={"PreToolUse": [HookMatcher(matcher=None, hooks=[dummy_hook])]},
3252 ),
3253 ):
3254 print(message)
3255```
3256
3257Dieses Muster ermöglicht es Ihnen:
3258
3259* **Modell-Anfragen prüfen**: Protokollieren Sie, wenn das Modell die Ausführung außerhalb der Sandbox anfordert
3260* **Allowlists implementieren**: Erlauben Sie nur bestimmten Befehlen, außerhalb der Sandbox ausgeführt zu werden
3261* **Genehmigungsworkflows hinzufügen**: Erfordern Sie explizite Autorisierung für privilegierte Operationen
3262
3263<Warning>
3264 Befehle, die mit `dangerouslyDisableSandbox: True` ausgeführt werden, haben vollständigen Systemzugriff. Stellen Sie sicher, dass Ihr `can_use_tool`-Handler diese Anfragen sorgfältig validiert.
3265
3266 Wenn `permission_mode` auf `bypassPermissions` gesetzt ist und `allow_unsandboxed_commands` aktiviert ist, kann das Modell autonom Befehle außerhalb der Sandbox ausführen, ohne dass Genehmigungsaufforderungen angezeigt werden. Diese Kombination ermöglicht dem Modell effektiv, die Sandbox-Isolation stillschweigend zu verlassen.
3267</Warning>
3268
3269## Siehe auch
3270
3271* [SDK-Übersicht](/de/agent-sdk/overview) - Allgemeine SDK-Konzepte
3272* [TypeScript SDK-Referenz](/de/agent-sdk/typescript) - TypeScript SDK-Dokumentation
3273* [CLI-Referenz](/de/cli-reference) - Befehlszeilenschnittstelle
3274* [Häufige Workflows](/de/common-workflows) - Schritt-für-Schritt-Anleitungen
