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 - Python
6
7> Полный справочник API для Python Agent SDK, включая все функции, типы и классы.
8
9## Установка
10
11```bash theme={null}
12pip install claude-agent-sdk
13```
14
15## Выбор между `query()` и `ClaudeSDKClient`
16
17Python SDK предоставляет два способа взаимодействия с Claude Code:
18
19### Быстрое сравнение
20
21| Функция | `query()` | `ClaudeSDKClient` |
22| :------------------------------- | :----------------------------- | :-------------------------------------- |
23| **Сеанс** | Создает новый сеанс каждый раз | Повторно использует один и тот же сеанс |
24| **Разговор** | Один обмен | Несколько обменов в одном контексте |
25| **Соединение** | Управляется автоматически | Ручное управление |
26| **Потоковый ввод** | ✅ Поддерживается | ✅ Поддерживается |
27| **Прерывания** | ❌ Не поддерживается | ✅ Поддерживается |
28| **Hooks** | ✅ Поддерживается | ✅ Поддерживается |
29| **Пользовательские инструменты** | ✅ Поддерживается | ✅ Поддерживается |
30| **Продолжить чат** | ❌ Новый сеанс каждый раз | ✅ Сохраняет разговор |
31| **Вариант использования** | Одноразовые задачи | Непрерывные разговоры |
32
33### Когда использовать `query()` (новый сеанс каждый раз)
34
35**Лучше всего для:**
36
37* Одноразовых вопросов, когда вам не нужна история разговора
38* Независимых задач, которые не требуют контекста из предыдущих обменов
39* Простых скриптов автоматизации
40* Когда вы хотите начать с чистого листа каждый раз
41
42### Когда использовать `ClaudeSDKClient` (непрерывный разговор)
43
44**Лучше всего для:**
45
46* **Продолжения разговоров** - Когда вам нужно, чтобы Claude помнил контекст
47* **Уточняющих вопросов** - Построение на основе предыдущих ответов
48* **Интерактивных приложений** - Интерфейсы чата, REPL
49* **Логики, управляемой ответом** - Когда следующее действие зависит от ответа Claude
50* **Управления сеансом** - Явное управление жизненным циклом разговора
51
52## Функции
53
54### `query()`
55
56Создает новый сеанс для каждого взаимодействия с Claude Code. Возвращает асинхронный итератор, который выдает сообщения по мере их поступления. Каждый вызов `query()` начинается с нуля без памяти о предыдущих взаимодействиях.
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#### Параметры
68
69| Параметр | Тип | Описание |
70| :---------- | :--------------------------- | :--------------------------------------------------------------------------------------- |
71| `prompt` | `str \| AsyncIterable[dict]` | Входная подсказка в виде строки или асинхронного итератора для режима потоковой передачи |
72| `options` | `ClaudeAgentOptions \| None` | Объект дополнительной конфигурации (по умолчанию `ClaudeAgentOptions()`, если None) |
73| `transport` | `Transport \| None` | Дополнительный пользовательский транспорт для связи с процессом CLI |
74
75#### Возвращаемое значение
76
77Возвращает `AsyncIterator[Message]`, который выдает сообщения из разговора.
78
79#### Пример - С параметрами
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
102Декоратор для определения MCP tools с проверкой типов.
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#### Параметры
114
115| Параметр | Тип | Описание |
116| :------------- | :----------------------------------------------- | :------------------------------------------------------------------------------ |
117| `name` | `str` | Уникальный идентификатор инструмента |
118| `description` | `str` | Понятное описание того, что делает инструмент |
119| `input_schema` | `type \| dict[str, Any]` | Схема, определяющая входные параметры инструмента (см. ниже) |
120| `annotations` | [`ToolAnnotations`](#tool-annotations)` \| None` | Дополнительные аннотации MCP tool, предоставляющие подсказки поведения клиентам |
121
122#### Варианты схемы ввода
123
1241. **Простое сопоставление типов** (рекомендуется):
125
126 ```python theme={null}
127 {"text": str, "count": int, "enabled": bool}
128 ```
129
1302. **Формат JSON Schema** (для сложной валидации):
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#### Возвращаемое значение
143
144Функция-декоратор, которая оборачивает реализацию инструмента и возвращает экземпляр `SdkMcpTool`.
145
146#### Пример
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
160Переэкспортировано из `mcp.types` (также доступно как `from claude_agent_sdk import ToolAnnotations`). Все поля являются дополнительными подсказками; клиенты не должны полагаться на них для решений безопасности.
161
162| Поле | Тип | По умолчанию | Описание |
163| :---------------- | :------------- | :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
164| `title` | `str \| None` | `None` | Понятное название инструмента |
165| `readOnlyHint` | `bool \| None` | `False` | Если `True`, инструмент не изменяет свою среду |
166| `destructiveHint` | `bool \| None` | `True` | Если `True`, инструмент может выполнять деструктивные обновления (имеет смысл только когда `readOnlyHint` равен `False`) |
167| `idempotentHint` | `bool \| None` | `False` | Если `True`, повторные вызовы с одинаковыми аргументами не имеют дополнительного эффекта (имеет смысл только когда `readOnlyHint` равен `False`) |
168| `openWorldHint` | `bool \| None` | `True` | Если `True`, инструмент взаимодействует с внешними сущностями (например, веб-поиск). Если `False`, область инструмента закрыта (например, инструмент памяти) |
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
187Создайте встроенный MCP server, который работает в вашем приложении Python.
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#### Параметры
198
199| Параметр | Тип | По умолчанию | Описание |
200| :-------- | :------------------------------ | :----------- | :------------------------------------------------------------------ |
201| `name` | `str` | - | Уникальный идентификатор сервера |
202| `version` | `str` | `"1.0.0"` | Строка версии сервера |
203| `tools` | `list[SdkMcpTool[Any]] \| None` | `None` | Список функций инструментов, созданных с помощью декоратора `@tool` |
204
205#### Возвращаемое значение
206
207Возвращает объект `McpSdkServerConfig`, который можно передать в `ClaudeAgentOptions.mcp_servers`.
208
209#### Пример
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
240Выводит список прошлых сеансов с метаданными. Фильтруйте по каталогу проекта или выводите сеансы во всех проектах. Синхронно; возвращается немедленно.
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#### Параметры
251
252| Параметр | Тип | По умолчанию | Описание |
253| :------------------ | :------------ | :----------- | :------------------------------------------------------------------------------------------ |
254| `directory` | `str \| None` | `None` | Каталог для вывода сеансов. Если опущено, возвращает сеансы во всех проектах |
255| `limit` | `int \| None` | `None` | Максимальное количество возвращаемых сеансов |
256| `include_worktrees` | `bool` | `True` | Когда `directory` находится внутри репозитория git, включайте сеансы из всех путей worktree |
257
258#### Тип возвращаемого значения: `SDKSessionInfo`
259
260| Свойство | Тип | Описание |
261| :-------------- | :------------ | :---------------------------------------------------------------------------------------------------- |
262| `session_id` | `str` | Уникальный идентификатор сеанса |
263| `summary` | `str` | Отображаемое название: пользовательское название, автоматически созданное резюме или первая подсказка |
264| `last_modified` | `int` | Время последнего изменения в миллисекундах с начала эпохи |
265| `file_size` | `int \| None` | Размер файла сеанса в байтах (`None` для удаленных хранилищ) |
266| `custom_title` | `str \| None` | Название сеанса, установленное пользователем |
267| `first_prompt` | `str \| None` | Первая значимая подсказка пользователя в сеансе |
268| `git_branch` | `str \| None` | Ветка Git в конце сеанса |
269| `cwd` | `str \| None` | Рабочий каталог для сеанса |
270| `tag` | `str \| None` | Тег сеанса, установленный пользователем (см. [`tag_session()`](#tag-session)) |
271| `created_at` | `int \| None` | Время создания сеанса в миллисекундах с начала эпохи |
272
273#### Пример
274
275Выведите 10 самых последних сеансов для проекта. Результаты отсортированы по `last_modified` в убывающем порядке, поэтому первый элемент - самый новый. Опустите `directory`, чтобы искать во всех проектах.
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
286Извлекает сообщения из прошлого сеанса. Синхронно; возвращается немедленно.
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#### Параметры
298
299| Параметр | Тип | По умолчанию | Описание |
300| :----------- | :------------ | :----------- | :-------------------------------------------------------------- |
301| `session_id` | `str` | обязательно | ID сеанса для извлечения сообщений |
302| `directory` | `str \| None` | `None` | Каталог проекта для поиска. Если опущено, ищет во всех проектах |
303| `limit` | `int \| None` | `None` | Максимальное количество возвращаемых сообщений |
304| `offset` | `int` | `0` | Количество сообщений для пропуска с начала |
305
306#### Тип возвращаемого значения: `SessionMessage`
307
308| Свойство | Тип | Описание |
309| :------------------- | :----------------------------- | :----------------------------------------- |
310| `type` | `Literal["user", "assistant"]` | Роль сообщения |
311| `uuid` | `str` | Уникальный идентификатор сообщения |
312| `session_id` | `str` | Идентификатор сеанса |
313| `message` | `Any` | Необработанное содержимое сообщения |
314| `parent_tool_use_id` | `None` | Зарезервировано для будущего использования |
315
316#### Пример
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
330Читает метаданные для одного сеанса по ID без сканирования полного каталога проекта. Синхронно; возвращается немедленно.
331
332```python theme={null}
333def get_session_info(
334 session_id: str,
335 directory: str | None = None,
336) -> SDKSessionInfo | None
337```
338
339#### Параметры
340
341| Параметр | Тип | По умолчанию | Описание |
342| :----------- | :------------ | :----------- | :------------------------------------------------------------------- |
343| `session_id` | `str` | обязательно | UUID сеанса для поиска |
344| `directory` | `str \| None` | `None` | Путь каталога проекта. Если опущено, ищет во всех каталогах проектов |
345
346Возвращает [`SDKSessionInfo`](#return-type-sdk-session-info) или `None`, если сеанс не найден.
347
348#### Пример
349
350Найдите метаданные одного сеанса без сканирования каталога проекта. Полезно, когда у вас уже есть ID сеанса из предыдущего запуска.
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
362Переименовывает сеанс, добавляя запись с пользовательским названием. Повторные вызовы безопасны; побеждает самое последнее название. Синхронно.
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#### Параметры
373
374| Параметр | Тип | По умолчанию | Описание |
375| :----------- | :------------ | :----------- | :------------------------------------------------------------------- |
376| `session_id` | `str` | обязательно | UUID сеанса для переименования |
377| `title` | `str` | обязательно | Новое название. Должно быть непустым после удаления пробелов |
378| `directory` | `str \| None` | `None` | Путь каталога проекта. Если опущено, ищет во всех каталогах проектов |
379
380Вызывает `ValueError`, если `session_id` не является допустимым UUID или `title` пуст; `FileNotFoundError`, если сеанс не найден.
381
382#### Пример
383
384Переименуйте самый последний сеанс, чтобы его было легче найти позже. Новое название появляется в [`SDKSessionInfo.custom_title`](#return-type-sdk-session-info) при последующих чтениях.
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
396Помечает сеанс. Передайте `None` для очистки тега. Повторные вызовы безопасны; побеждает самый последний тег. Синхронно.
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#### Параметры
407
408| Параметр | Тип | По умолчанию | Описание |
409| :----------- | :------------ | :----------- | :------------------------------------------------------------------------- |
410| `session_id` | `str` | обязательно | UUID сеанса для пометки |
411| `tag` | `str \| None` | обязательно | Строка тега или `None` для очистки. Очищается от Unicode перед сохранением |
412| `directory` | `str \| None` | `None` | Путь каталога проекта. Если опущено, ищет во всех каталогах проектов |
413
414Вызывает `ValueError`, если `session_id` не является допустимым UUID или `tag` пуст после очистки; `FileNotFoundError`, если сеанс не найден.
415
416#### Пример
417
418Пометьте сеанс, затем отфильтруйте по этому тегу при последующем чтении. Передайте `None` для очистки существующего тега.
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## Классы
433
434### `ClaudeSDKClient`
435
436**Поддерживает сеанс разговора через несколько обменов.** Это эквивалент Python того, как функция `query()` TypeScript SDK работает внутри - она создает объект клиента, который может продолжать разговоры.
437
438#### Ключевые особенности
439
440* **Непрерывность сеанса**: Поддерживает контекст разговора через несколько вызовов `query()`
441* **Один разговор**: Сеанс сохраняет предыдущие сообщения
442* **Поддержка прерываний**: Может остановить выполнение в середине задачи
443* **Явный жизненный цикл**: Вы контролируете, когда сеанс начинается и заканчивается
444* **Поток, управляемый ответом**: Может реагировать на ответы и отправлять дополнения
445* **Пользовательские инструменты и hooks**: Поддерживает пользовательские инструменты (созданные с помощью декоратора `@tool`) и 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#### Методы
467
468| Метод | Описание |
469| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
470| `__init__(options)` | Инициализируйте клиент с дополнительной конфигурацией |
471| `connect(prompt)` | Подключитесь к Claude с дополнительной начальной подсказкой или потоком сообщений |
472| `query(prompt, session_id)` | Отправьте новый запрос в режиме потоковой передачи |
473| `receive_messages()` | Получайте все сообщения от Claude как асинхронный итератор |
474| `receive_response()` | Получайте сообщения до и включая ResultMessage |
475| `interrupt()` | Отправьте сигнал прерывания (работает только в режиме потоковой передачи) |
476| `set_permission_mode(mode)` | Измените режим разрешений для текущего сеанса |
477| `set_model(model)` | Измените модель для текущего сеанса. Передайте `None` для сброса на значение по умолчанию |
478| `rewind_files(user_message_id)` | Восстановите файлы в их состояние в указанном пользовательском сообщении. Требует `enable_file_checkpointing=True`. См. [File checkpointing](/ru/agent-sdk/file-checkpointing) |
479| `get_mcp_status()` | Получите статус всех настроенных MCP servers. Возвращает [`McpStatusResponse`](#mcp-status-response) |
480| `reconnect_mcp_server(server_name)` | Повторите попытку подключения к MCP server, который не удался или был отключен |
481| `toggle_mcp_server(server_name, enabled)` | Включите или отключите MCP server в середине сеанса. Отключение удаляет его инструменты |
482| `stop_task(task_id)` | Остановите выполняющуюся фоновую задачу. [`TaskNotificationMessage`](#task-notification-message) со статусом `"stopped"` следует в потоке сообщений |
483| `get_server_info()` | Получите информацию о сервере, включая ID сеанса и возможности |
484| `disconnect()` | Отключитесь от Claude |
485
486#### Поддержка менеджера контекста
487
488Клиент можно использовать как асинхронный менеджер контекста для автоматического управления соединением:
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> **Важно:** При итерации по сообщениям избегайте использования `break` для раннего выхода, так как это может вызвать проблемы с очисткой asyncio. Вместо этого позвольте итерации завершиться естественным образом или используйте флаги для отслеживания, когда вы нашли то, что вам нужно.
498
499#### Пример - Продолжение разговора
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#### Пример - Потоковый ввод с 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#### Пример - Использование прерываний
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 **Поведение буфера после прерывания:** `interrupt()` отправляет сигнал остановки, но не очищает буфер сообщений. Сообщения, уже созданные прерванной задачей, включая ее `ResultMessage` (с `subtype="error_during_execution"`), остаются в потоке. Вы должны слить их с помощью `receive_response()` перед чтением ответа на новый запрос. Если вы отправите новый запрос сразу после `interrupt()` и вызовете `receive_response()` только один раз, вы получите сообщения прерванной задачи, а не ответ на новый запрос.
625</Note>
626
627#### Пример - Расширенное управление разрешениями
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## Типы
677
678<Note>
679 **`@dataclass` vs `TypedDict`:** Этот SDK использует два вида типов. Классы, украшенные `@dataclass` (такие как `ResultMessage`, `AgentDefinition`, `TextBlock`), являются экземплярами объектов во время выполнения и поддерживают доступ к атрибутам: `msg.result`. Классы, определенные с помощью `TypedDict` (такие как `ThinkingConfigEnabled`, `McpStdioServerConfig`, `SyncHookJSONOutput`), являются **простыми словарями во время выполнения** и требуют доступа к ключам: `config["budget_tokens"]`, а не `config.budget_tokens`. Синтаксис вызова `ClassName(field=value)` работает для обоих, но только dataclasses создают объекты с атрибутами.
680</Note>
681
682### `SdkMcpTool`
683
684Определение для SDK MCP tool, созданного с помощью декоратора `@tool`.
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| Свойство | Тип | Описание |
697| :------------- | :----------------------------------------- | :--------------------------------------------------------------------------------------------------------------- |
698| `name` | `str` | Уникальный идентификатор инструмента |
699| `description` | `str` | Понятное описание |
700| `input_schema` | `type[T] \| dict[str, Any]` | Схема для валидации ввода |
701| `handler` | `Callable[[T], Awaitable[dict[str, Any]]]` | Асинхронная функция, которая обрабатывает выполнение инструмента |
702| `annotations` | `ToolAnnotations \| None` | Дополнительные аннотации MCP tool (например, `readOnlyHint`, `destructiveHint`, `openWorldHint`). Из `mcp.types` |
703
704### `Transport`
705
706Абстрактный базовый класс для пользовательских реализаций транспорта. Используйте это для связи с процессом Claude через пользовательский канал (например, удаленное соединение вместо локального подпроцесса).
707
708<Warning>
709 Это низкоуровневый внутренний API. Интерфейс может измениться в будущих выпусках. Пользовательские реализации должны быть обновлены в соответствии с любыми изменениями интерфейса.
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| Метод | Описание |
739| :---------------- | :---------------------------------------------------------------------------- |
740| `connect()` | Подключите транспорт и подготовьте к связи |
741| `write(data)` | Напишите необработанные данные (JSON + новая строка) в транспорт |
742| `read_messages()` | Асинхронный итератор, который выдает разобранные JSON сообщения |
743| `close()` | Закройте соединение и очистите ресурсы |
744| `is_ready()` | Возвращает `True`, если транспорт может отправлять и получать |
745| `end_input()` | Закройте входной поток (например, закройте stdin для транспортов подпроцесса) |
746
747Импорт: `from claude_agent_sdk import Transport`
748
749### `ClaudeAgentOptions`
750
751Dataclass конфигурации для запросов Claude Code.
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| Свойство | Тип | По умолчанию | Описание |
797| :---------------------------- | :------------------------------------------------------------------------------------- | :--------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
798| `tools` | `list[str] \| ToolsPreset \| None` | `None` | Конфигурация инструментов. Используйте `{"type": "preset", "preset": "claude_code"}` для инструментов Claude Code по умолчанию |
799| `allowed_tools` | `list[str]` | `[]` | Инструменты для автоматического одобрения без запроса. Это не ограничивает Claude только этими инструментами; неуказанные инструменты переходят к `permission_mode` и `can_use_tool`. Используйте `disallowed_tools` для блокировки инструментов. См. [Permissions](/ru/agent-sdk/permissions#allow-and-deny-rules) |
800| `system_prompt` | `str \| SystemPromptPreset \| None` | `None` | Конфигурация системной подсказки. Передайте строку для пользовательской подсказки или используйте `{"type": "preset", "preset": "claude_code"}` для системной подсказки Claude Code. Добавьте `"append"` для расширения предустановки |
801| `mcp_servers` | `dict[str, McpServerConfig] \| str \| Path` | `{}` | Конфигурации MCP server или путь к файлу конфигурации |
802| `permission_mode` | `PermissionMode \| None` | `None` | Режим разрешений для использования инструментов |
803| `continue_conversation` | `bool` | `False` | Продолжить самый последний разговор |
804| `resume` | `str \| None` | `None` | ID сеанса для возобновления |
805| `max_turns` | `int \| None` | `None` | Максимальное количество агентских ходов (раунды использования инструментов) |
806| `max_budget_usd` | `float \| None` | `None` | Остановите запрос, когда оценка стоимости на стороне клиента достигнет этого значения USD. Сравнивается с той же оценкой, что и `total_cost_usd`; см. [Track cost and usage](/ru/agent-sdk/cost-tracking) для предостережений точности |
807| `disallowed_tools` | `list[str]` | `[]` | Инструменты для всегда отклонения. Правила отклонения проверяются первыми и переопределяют `allowed_tools` и `permission_mode` (включая `bypassPermissions`) |
808| `enable_file_checkpointing` | `bool` | `False` | Включить отслеживание изменений файлов для перемотки. См. [File checkpointing](/ru/agent-sdk/file-checkpointing) |
809| `model` | `str \| None` | `None` | Модель Claude для использования |
810| `fallback_model` | `str \| None` | `None` | Резервная модель для использования, если основная модель не работает |
811| `betas` | `list[SdkBeta]` | `[]` | Функции бета-версии для включения. См. [`SdkBeta`](#sdk-beta) для доступных опций |
812| `output_format` | `dict[str, Any] \| None` | `None` | Формат вывода для структурированных ответов (например, `{"type": "json_schema", "schema": {...}}`). См. [Structured outputs](/ru/agent-sdk/structured-outputs) для деталей |
813| `permission_prompt_tool_name` | `str \| None` | `None` | Имя MCP tool для подсказок разрешений |
814| `cwd` | `str \| Path \| None` | `None` | Текущий рабочий каталог |
815| `cli_path` | `str \| Path \| None` | `None` | Пользовательский путь к исполняемому файлу Claude Code CLI |
816| `settings` | `str \| None` | `None` | Путь к файлу параметров |
817| `add_dirs` | `list[str \| Path]` | `[]` | Дополнительные каталоги, к которым Claude может получить доступ |
818| `env` | `dict[str, str]` | `{}` | Переменные окружения, объединенные поверх унаследованного окружения процесса. См. [Environment variables](/ru/env-vars) для переменных, которые читает базовый CLI |
819| `extra_args` | `dict[str, str \| None]` | `{}` | Дополнительные аргументы CLI для прямой передачи в CLI |
820| `max_buffer_size` | `int \| None` | `None` | Максимальные байты при буферизации stdout CLI |
821| `debug_stderr` | `Any` | `sys.stderr` | *Устарело* - Объект, подобный файлу, для вывода отладки. Вместо этого используйте обратный вызов `stderr` |
822| `stderr` | `Callable[[str], None] \| None` | `None` | Функция обратного вызова для вывода stderr из CLI |
823| `can_use_tool` | [`CanUseTool`](#can-use-tool) ` \| None` | `None` | Функция обратного вызова разрешения инструмента. См. [Permission types](#can-use-tool) для деталей |
824| `hooks` | `dict[HookEvent, list[HookMatcher]] \| None` | `None` | Конфигурации hooks для перехвата событий |
825| `user` | `str \| None` | `None` | Идентификатор пользователя |
826| `include_partial_messages` | `bool` | `False` | Включить события потоковой передачи частичных сообщений. Когда включено, выдаются сообщения [`StreamEvent`](#stream-event) |
827| `fork_session` | `bool` | `False` | При возобновлении с `resume` разветвитесь на новый ID сеанса вместо продолжения исходного сеанса |
828| `agents` | `dict[str, AgentDefinition] \| None` | `None` | Программно определенные подагенты |
829| `plugins` | `list[SdkPluginConfig]` | `[]` | Загрузите пользовательские plugins из локальных путей. См. [Plugins](/ru/agent-sdk/plugins) для деталей |
830| `sandbox` | [`SandboxSettings`](#sandbox-settings) ` \| None` | `None` | Программно настройте поведение sandbox. См. [Sandbox settings](#sandbox-settings) для деталей |
831| `setting_sources` | `list[SettingSource] \| None` | `None` (CLI defaults: all sources) | Контролируйте, какие параметры файловой системы загружать. Передайте `[]` для отключения пользовательских, проектных и локальных параметров. Управляемые параметры политики загружаются независимо. См. [Use Claude Code features](/ru/agent-sdk/claude-code-features#what-settingsources-does-not-control) |
832| `max_thinking_tokens` | `int \| None` | `None` | *Устарело* - Максимальные токены для блоков мышления. Вместо этого используйте `thinking` |
833| `thinking` | [`ThinkingConfig`](#thinking-config) ` \| None` | `None` | Управляет поведением расширенного мышления. Имеет приоритет над `max_thinking_tokens` |
834| `effort` | `Literal["low", "medium", "high", "max"] \| None` | `None` | Уровень усилий для глубины мышления |
835| `session_store` | [`SessionStore`](/ru/agent-sdk/session-storage#the-session-store-interface) ` \| None` | `None` | Зеркалируйте стенограммы сеансов во внешний бэкэнд, чтобы любой хост мог их возобновить. См. [Persist sessions to external storage](/ru/agent-sdk/session-storage) |
836
837### `OutputFormat`
838
839Конфигурация для валидации структурированного вывода. Передайте это как `dict` в поле `output_format` на `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| Поле | Обязательно | Описание |
850| :------- | :---------- | :---------------------------------------------------- |
851| `type` | Да | Должно быть `"json_schema"` для валидации JSON Schema |
852| `schema` | Да | Определение JSON Schema для валидации вывода |
853
854### `SystemPromptPreset`
855
856Конфигурация для использования предустановленной системной подсказки Claude Code с дополнительными добавлениями.
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| Поле | Обязательно | Описание |
867| :------------------------- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
868| `type` | Да | Должно быть `"preset"` для использования предустановленной системной подсказки |
869| `preset` | Да | Должно быть `"claude_code"` для использования системной подсказки Claude Code |
870| `append` | Нет | Дополнительные инструкции для добавления к предустановленной системной подсказке |
871| `exclude_dynamic_sections` | Нет | Переместите контекст для каждого сеанса, такой как рабочий каталог, статус git и пути памяти, из системной подсказки в первое пользовательское сообщение. Улучшает повторное использование кэша подсказок между пользователями и машинами. См. [Modify system prompts](/ru/agent-sdk/modifying-system-prompts#improve-prompt-caching-across-users-and-machines) |
872
873### `SettingSource`
874
875Управляет тем, какие источники конфигурации на основе файловой системы загружает SDK.
876
877```python theme={null}
878SettingSource = Literal["user", "project", "local"]
879```
880
881| Значение | Описание | Местоположение |
882| :---------- | :----------------------------------------------- | :---------------------------- |
883| `"user"` | Глобальные параметры пользователя | `~/.claude/settings.json` |
884| `"project"` | Общие параметры проекта (контролируемые версией) | `.claude/settings.json` |
885| `"local"` | Локальные параметры проекта (gitignored) | `.claude/settings.local.json` |
886
887#### Поведение по умолчанию
888
889Когда `setting_sources` опущено или `None`, `query()` загружает те же параметры файловой системы, что и Claude Code CLI: пользовательские, проектные и локальные. Управляемые параметры политики загружаются во всех случаях. См. [What settingSources does not control](/ru/agent-sdk/claude-code-features#what-settingsources-does-not-control) для входов, которые читаются независимо от этой опции, и как их отключить.
890
891#### Почему использовать setting\_sources
892
893**Отключить параметры файловой системы:**
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 В Python SDK 0.1.59 и более ранних версиях пустой список рассматривался так же, как опущение опции, поэтому `setting_sources=[]` не отключал параметры файловой системы. Обновитесь до более новой версии, если вам нужно, чтобы пустой список вступил в силу. TypeScript SDK не затронут.
910</Note>
911
912**Загрузить все параметры файловой системы явно:**
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**Загрузить только определенные источники параметров:**
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**Тестирование и окружения CI:**
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:**
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**Загрузка инструкций проекта CLAUDE.md:**
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#### Приоритет параметров
989
990Когда загружаются несколько источников, параметры объединяются с этим приоритетом (от наивысшего к наименьшему):
991
9921. Локальные параметры (`.claude/settings.local.json`)
9932. Параметры проекта (`.claude/settings.json`)
9943. Параметры пользователя (`~/.claude/settings.json`)
995
996Программные опции, такие как `agents` и `allowed_tools`, переопределяют параметры пользователя, проекта и локальной файловой системы. Управляемые параметры политики имеют приоритет над программными опциями.
997
998### `AgentDefinition`
999
1000Конфигурация для подагента, определенного программно.
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| Поле | Обязательно | Описание |
1021| :---------------- | :---------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1022| `description` | Да | Описание на естественном языке, когда использовать этого агента |
1023| `prompt` | Да | Системная подсказка агента |
1024| `tools` | Нет | Массив разрешенных имен инструментов. Если опущено, наследует все инструменты |
1025| `disallowedTools` | Нет | Массив имен инструментов для удаления из набора инструментов агента |
1026| `model` | Нет | Переопределение модели для этого агента. Принимает псевдоним, такой как `"sonnet"`, `"opus"`, `"haiku"` или `"inherit"`, или полный ID модели. Если опущено, использует основную модель |
1027| `skills` | Нет | Список имен skills, доступных этому агенту |
1028| `memory` | Нет | Источник памяти для этого агента: `"user"`, `"project"` или `"local"` |
1029| `mcpServers` | Нет | MCP servers, доступные этому агенту. Каждая запись - это имя сервера или встроенный словарь `{name: config}` |
1030| `initialPrompt` | Нет | Автоматически отправляется как первый ход пользователя, когда этот агент работает как основной агент потока |
1031| `maxTurns` | Нет | Максимальное количество агентских ходов перед остановкой агента |
1032| `background` | Нет | Запустите этого агента как неблокирующую фоновую задачу при вызове |
1033| `effort` | Нет | Уровень усилий рассуждения для этого агента. Принимает именованный уровень или целое число |
1034| `permissionMode` | Нет | Режим разрешений для выполнения инструментов в этом агенте. См. [`PermissionMode`](#permission-mode) |
1035
1036<Note>
1037 Имена полей `AgentDefinition` используют camelCase, такие как `disallowedTools`, `permissionMode` и `maxTurns`. Эти имена напрямую соответствуют формату проводки, общему с TypeScript SDK. Это отличается от `ClaudeAgentOptions`, который использует Python snake\_case для эквивалентных полей верхнего уровня, таких как `disallowed_tools` и `permission_mode`. Поскольку `AgentDefinition` является dataclass, передача ключевого слова snake\_case вызывает `TypeError` во время конструирования.
1038</Note>
1039
1040### `PermissionMode`
1041
1042Режимы разрешений для управления выполнением инструментов.
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
1056Псевдоним типа для функций обратного вызова разрешения инструмента.
1057
1058```python theme={null}
1059CanUseTool = Callable[
1060 [str, dict[str, Any], ToolPermissionContext], Awaitable[PermissionResult]
1061]
1062```
1063
1064Обратный вызов получает:
1065
1066* `tool_name`: Имя вызываемого инструмента
1067* `input_data`: Входные параметры инструмента
1068* `context`: `ToolPermissionContext` с дополнительной информацией
1069
1070Возвращает `PermissionResult` (либо `PermissionResultAllow`, либо `PermissionResultDeny`).
1071
1072### `ToolPermissionContext`
1073
1074Информация контекста, передаваемая в обратные вызовы разрешения инструмента.
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| Поле | Тип | Описание |
1084| :------------ | :----------------------- | :------------------------------------------------------- |
1085| `signal` | `Any \| None` | Зарезервировано для будущей поддержки сигнала прерывания |
1086| `suggestions` | `list[PermissionUpdate]` | Предложения обновления разрешений из CLI |
1087
1088### `PermissionResult`
1089
1090Тип объединения для результатов обратного вызова разрешения.
1091
1092```python theme={null}
1093PermissionResult = PermissionResultAllow | PermissionResultDeny
1094```
1095
1096### `PermissionResultAllow`
1097
1098Результат, указывающий, что вызов инструмента должен быть разрешен.
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| Поле | Тип | По умолчанию | Описание |
1109| :-------------------- | :------------------------------- | :----------- | :------------------------------------------------- |
1110| `behavior` | `Literal["allow"]` | `"allow"` | Должно быть "allow" |
1111| `updated_input` | `dict[str, Any] \| None` | `None` | Измененный ввод для использования вместо оригинала |
1112| `updated_permissions` | `list[PermissionUpdate] \| None` | `None` | Обновления разрешений для применения |
1113
1114### `PermissionResultDeny`
1115
1116Результат, указывающий, что вызов инструмента должен быть отклонен.
1117
1118```python theme={null}
1119@dataclass
1120class PermissionResultDeny:
1121 behavior: Literal["deny"] = "deny"
1122 message: str = ""
1123 interrupt: bool = False
1124```
1125
1126| Поле | Тип | По умолчанию | Описание |
1127| :---------- | :---------------- | :----------- | :----------------------------------------------------- |
1128| `behavior` | `Literal["deny"]` | `"deny"` | Должно быть "deny" |
1129| `message` | `str` | `""` | Сообщение, объясняющее, почему инструмент был отклонен |
1130| `interrupt` | `bool` | `False` | Следует ли прерывать текущее выполнение |
1131
1132### `PermissionUpdate`
1133
1134Конфигурация для программного обновления разрешений.
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| Поле | Тип | Описание |
1157| :------------ | :---------------------------------------- | :------------------------------------------------- |
1158| `type` | `Literal[...]` | Тип операции обновления разрешений |
1159| `rules` | `list[PermissionRuleValue] \| None` | Правила для операций добавления/замены/удаления |
1160| `behavior` | `Literal["allow", "deny", "ask"] \| None` | Поведение для операций на основе правил |
1161| `mode` | `PermissionMode \| None` | Режим для операции setMode |
1162| `directories` | `list[str] \| None` | Каталоги для операций добавления/удаления каталога |
1163| `destination` | `Literal[...] \| None` | Где применить обновление разрешений |
1164
1165### `PermissionRuleValue`
1166
1167Правило для добавления, замены или удаления в обновлении разрешений.
1168
1169```python theme={null}
1170@dataclass
1171class PermissionRuleValue:
1172 tool_name: str
1173 rule_content: str | None = None
1174```
1175
1176### `ToolsPreset`
1177
1178Конфигурация предустановленных инструментов для использования набора инструментов Claude Code по умолчанию.
1179
1180```python theme={null}
1181class ToolsPreset(TypedDict):
1182 type: Literal["preset"]
1183 preset: Literal["claude_code"]
1184```
1185
1186### `ThinkingConfig`
1187
1188Управляет поведением расширенного мышления. Объединение трех конфигураций:
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| Вариант | Поля | Описание |
1208| :--------- | :---------------------- | :------------------------------------------------ |
1209| `adaptive` | `type` | Claude адаптивно решает, когда думать |
1210| `enabled` | `type`, `budget_tokens` | Включить мышление с определенным бюджетом токенов |
1211| `disabled` | `type` | Отключить мышление |
1212
1213Поскольку это классы `TypedDict`, они являются простыми словарями во время выполнения. Либо создавайте их как литералы словарей, либо вызывайте класс как конструктор; оба создают `dict`. Получайте доступ к полям с помощью `config["budget_tokens"]`, а не `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
1229Тип Literal для функций бета-версии SDK.
1230
1231```python theme={null}
1232SdkBeta = Literal["context-1m-2025-08-07"]
1233```
1234
1235Используйте с полем `betas` в `ClaudeAgentOptions` для включения функций бета-версии.
1236
1237<Warning>
1238 Бета-версия `context-1m-2025-08-07` снята с производства по состоянию на 30 апреля 2026 года. Передача этого заголовка с Claude Sonnet 4.5 или Sonnet 4 не имеет эффекта, и запросы, превышающие стандартное окно контекста 200k-токенов, возвращают ошибку. Чтобы использовать окно контекста 1M-токенов, перейдите на [Claude Sonnet 4.6, Claude Opus 4.6 или Claude Opus 4.7](https://platform.claude.com/docs/en/about-claude/models/overview), которые включают контекст 1M по стандартной цене без требования заголовка бета-версии.
1239</Warning>
1240
1241### `McpSdkServerConfig`
1242
1243Конфигурация для SDK MCP servers, созданных с помощью `create_sdk_mcp_server()`.
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
1254Тип объединения для конфигураций MCP server.
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
1292Конфигурация MCP server, как сообщается [`get_mcp_status()`](#methods). Это объединение всех вариантов транспорта [`McpServerConfig`](#mcp-server-config) плюс вариант `claudeai-proxy` только для вывода для servers, проксированных через claude.ai.
1293
1294```python theme={null}
1295McpServerStatusConfig = (
1296 McpStdioServerConfig
1297 | McpSSEServerConfig
1298 | McpHttpServerConfig
1299 | McpSdkServerConfigStatus
1300 | McpClaudeAIProxyServerConfig
1301)
1302```
1303
1304`McpSdkServerConfigStatus` - это сериализуемая форма [`McpSdkServerConfig`](#mcp-sdk-server-config) с только полями `type` (`"sdk"`) и `name` (`str`); встроенный `instance` опущен. `McpClaudeAIProxyServerConfig` имеет поля `type` (`"claudeai-proxy"`), `url` (`str`) и `id` (`str`).
1305
1306### `McpStatusResponse`
1307
1308Ответ от [`ClaudeSDKClient.get_mcp_status()`](#methods). Оборачивает список статусов сервера под ключом `mcpServers`.
1309
1310```python theme={null}
1311class McpStatusResponse(TypedDict):
1312 mcpServers: list[McpServerStatus]
1313```
1314
1315### `McpServerStatus`
1316
1317Статус подключенного MCP server, содержащийся в [`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| Поле | Тип | Описание |
1331| :----------- | :----------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1332| `name` | `str` | Имя сервера |
1333| `status` | `str` | Один из `"connected"`, `"failed"`, `"needs-auth"`, `"pending"` или `"disabled"` |
1334| `serverInfo` | `dict` (опционально) | Имя и версия сервера (`{"name": str, "version": str}`) |
1335| `error` | `str` (опционально) | Сообщение об ошибке, если серверу не удалось подключиться |
1336| `config` | [`McpServerStatusConfig`](#mcp-server-status-config) (опционально) | Конфигурация сервера. Та же форма, что и [`McpServerConfig`](#mcp-server-config) (stdio, SSE, HTTP или SDK), плюс вариант `claudeai-proxy` для servers, подключенных через claude.ai |
1337| `scope` | `str` (опционально) | Область конфигурации |
1338| `tools` | `list` (опционально) | Инструменты, предоставляемые этим сервером, каждый с полями `name`, `description` и `annotations` |
1339
1340### `SdkPluginConfig`
1341
1342Конфигурация для загрузки plugins в SDK.
1343
1344```python theme={null}
1345class SdkPluginConfig(TypedDict):
1346 type: Literal["local"]
1347 path: str
1348```
1349
1350| Поле | Тип | Описание |
1351| :----- | :----------------- | :-------------------------------------------------------------------------------- |
1352| `type` | `Literal["local"]` | Должно быть `"local"` (в настоящее время поддерживаются только локальные plugins) |
1353| `path` | `str` | Абсолютный или относительный путь к каталогу plugin |
1354
1355**Пример:**
1356
1357```python theme={null}
1358plugins = [
1359 {"type": "local", "path": "./my-plugin"},
1360 {"type": "local", "path": "/absolute/path/to/plugin"},
1361]
1362```
1363
1364Для полной информации о создании и использовании plugins см. [Plugins](/ru/agent-sdk/plugins).
1365
1366## Типы сообщений
1367
1368### `Message`
1369
1370Тип объединения всех возможных сообщений.
1371
1372```python theme={null}
1373Message = (
1374 UserMessage
1375 | AssistantMessage
1376 | SystemMessage
1377 | ResultMessage
1378 | StreamEvent
1379 | RateLimitEvent
1380)
1381```
1382
1383### `UserMessage`
1384
1385Сообщение пользовательского ввода.
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| Поле | Тип | Описание |
1397| :------------------- | :-------------------------- | :--------------------------------------------------------------------------------------- |
1398| `content` | `str \| list[ContentBlock]` | Содержимое сообщения как текст или блоки содержимого |
1399| `uuid` | `str \| None` | Уникальный идентификатор сообщения |
1400| `parent_tool_use_id` | `str \| None` | ID использования инструмента, если это сообщение является ответом результата инструмента |
1401| `tool_use_result` | `dict[str, Any] \| None` | Данные результата инструмента, если применимо |
1402
1403### `AssistantMessage`
1404
1405Сообщение ответа помощника с блоками содержимого.
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| Поле | Тип | Описание |
1419| :------------------- | :------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- |
1420| `content` | `list[ContentBlock]` | Список блоков содержимого в ответе |
1421| `model` | `str` | Модель, которая создала ответ |
1422| `parent_tool_use_id` | `str \| None` | ID использования инструмента, если это вложенный ответ |
1423| `error` | [`AssistantMessageError`](#assistant-message-error) ` \| None` | Тип ошибки, если ответ столкнулся с ошибкой |
1424| `usage` | `dict[str, Any] \| None` | Использование токенов для каждого сообщения (те же ключи, что и [`ResultMessage.usage`](#result-message)) |
1425| `message_id` | `str \| None` | ID сообщения API. Несколько сообщений из одного хода имеют одинаковый ID |
1426
1427### `AssistantMessageError`
1428
1429Возможные типы ошибок для сообщений помощника.
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
1445Системное сообщение с метаданными.
1446
1447```python theme={null}
1448@dataclass
1449class SystemMessage:
1450 subtype: str
1451 data: dict[str, Any]
1452```
1453
1454### `ResultMessage`
1455
1456Финальное сообщение результата с информацией о стоимости и использовании.
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
1475Словарь `usage` содержит следующие ключи, если они присутствуют:
1476
1477| Ключ | Тип | Описание |
1478| ----------------------------- | ----- | ----------------------------------------------------- |
1479| `input_tokens` | `int` | Всего потреблено входных токенов. |
1480| `output_tokens` | `int` | Всего создано выходных токенов. |
1481| `cache_creation_input_tokens` | `int` | Токены, используемые для создания новых записей кэша. |
1482| `cache_read_input_tokens` | `int` | Токены, прочитанные из существующих записей кэша. |
1483
1484Словарь `model_usage` отображает имена моделей на использование для каждой модели. Внутренние ключи словаря используют camelCase, потому что значение передается без изменений из базового процесса CLI, соответствуя типу TypeScript [`ModelUsage`](/ru/agent-sdk/typescript#model-usage):
1485
1486| Ключ | Тип | Описание |
1487| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1488| `inputTokens` | `int` | Входные токены для этой модели. |
1489| `outputTokens` | `int` | Выходные токены для этой модели. |
1490| `cacheReadInputTokens` | `int` | Токены чтения кэша для этой модели. |
1491| `cacheCreationInputTokens` | `int` | Токены создания кэша для этой модели. |
1492| `webSearchRequests` | `int` | Запросы веб-поиска, сделанные этой моделью. |
1493| `costUSD` | `float` | Предполагаемая стоимость в USD для этой модели, вычисленная на стороне клиента. См. [Track cost and usage](/ru/agent-sdk/cost-tracking) для предостережений выставления счетов. |
1494| `contextWindow` | `int` | Размер окна контекста для этой модели. |
1495| `maxOutputTokens` | `int` | Максимальный лимит выходных токенов для этой модели. |
1496
1497### `StreamEvent`
1498
1499Событие потока для частичных обновлений сообщений во время потоковой передачи. Получается только когда `include_partial_messages=True` в `ClaudeAgentOptions`. Импортируйте через `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| Поле | Тип | Описание |
1511| :------------------- | :--------------- | :------------------------------------------------------------------------ |
1512| `uuid` | `str` | Уникальный идентификатор для этого события |
1513| `session_id` | `str` | Идентификатор сеанса |
1514| `event` | `dict[str, Any]` | Необработанные данные события потока Claude API |
1515| `parent_tool_use_id` | `str \| None` | ID использования родительского инструмента, если это событие из подагента |
1516
1517### `RateLimitEvent`
1518
1519Выдается при изменении статуса ограничения скорости (например, с `"allowed"` на `"allowed_warning"`). Используйте это для предупреждения пользователей перед достижением жесткого лимита или для отката, когда статус `"rejected"`.
1520
1521```python theme={null}
1522@dataclass
1523class RateLimitEvent:
1524 rate_limit_info: RateLimitInfo
1525 uuid: str
1526 session_id: str
1527```
1528
1529| Поле | Тип | Описание |
1530| :---------------- | :---------------------------------- | :------------------------------------- |
1531| `rate_limit_info` | [`RateLimitInfo`](#rate-limit-info) | Текущее состояние ограничения скорости |
1532| `uuid` | `str` | Уникальный идентификатор события |
1533| `session_id` | `str` | Идентификатор сеанса |
1534
1535### `RateLimitInfo`
1536
1537Состояние ограничения скорости, переносимое [`RateLimitEvent`](#rate-limit-event).
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| Поле | Тип | Описание |
1559| :------------------------ | :------------------------ | :---------------------------------------------------------------------------------------------------------------- |
1560| `status` | `RateLimitStatus` | Текущий статус. `"allowed_warning"` означает приближение к лимиту; `"rejected"` означает, что лимит был достигнут |
1561| `resets_at` | `int \| None` | Временная метка Unix, когда окно ограничения скорости сбрасывается |
1562| `rate_limit_type` | `RateLimitType \| None` | Какое окно ограничения скорости применяется |
1563| `utilization` | `float \| None` | Доля потребленного ограничения скорости (0,0 до 1,0) |
1564| `overage_status` | `RateLimitStatus \| None` | Статус использования переплаты по мере использования, если применимо |
1565| `overage_resets_at` | `int \| None` | Временная метка Unix, когда окно переплаты сбрасывается |
1566| `overage_disabled_reason` | `str \| None` | Почему переплата недоступна, если статус `"rejected"` |
1567| `raw` | `dict[str, Any]` | Полный необработанный словарь из CLI, включая поля, не смоделированные выше |
1568
1569### `TaskStartedMessage`
1570
1571Выдается при запуске фоновой задачи. Фоновая задача - это все, что отслеживается вне основного хода: фоновая команда Bash, наблюдение Monitor, подагент, порожденный через инструмент Agent, или удаленный агент. Поле `task_type` говорит вам, какой. Это именование не связано с переименованием инструмента `Task` на `Agent`.
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| Поле | Тип | Описание |
1585| :------------ | :------------ | :-------------------------------------------------------------------------------------------------------------------- |
1586| `task_id` | `str` | Уникальный идентификатор для задачи |
1587| `description` | `str` | Описание задачи |
1588| `uuid` | `str` | Уникальный идентификатор сообщения |
1589| `session_id` | `str` | Идентификатор сеанса |
1590| `tool_use_id` | `str \| None` | Связанный ID использования инструмента |
1591| `task_type` | `str \| None` | Какой вид фоновой задачи: `"local_bash"` для фонового Bash и наблюдений Monitor, `"local_agent"` или `"remote_agent"` |
1592
1593### `TaskUsage`
1594
1595Данные токенов и времени для фоновой задачи.
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
1606Выдается периодически с обновлениями прогресса для выполняющейся фоновой задачи.
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| Поле | Тип | Описание |
1621| :--------------- | :------------ | :------------------------------------------------------ |
1622| `task_id` | `str` | Уникальный идентификатор для задачи |
1623| `description` | `str` | Описание текущего статуса |
1624| `usage` | `TaskUsage` | Использование токенов для этой задачи до сих пор |
1625| `uuid` | `str` | Уникальный идентификатор сообщения |
1626| `session_id` | `str` | Идентификатор сеанса |
1627| `tool_use_id` | `str \| None` | Связанный ID использования инструмента |
1628| `last_tool_name` | `str \| None` | Имя последнего инструмента, который использовала задача |
1629
1630### `TaskNotificationMessage`
1631
1632Выдается при завершении, сбое или остановке фоновой задачи. Фоновые задачи включают команды Bash `run_in_background`, наблюдения Monitor и фоновые подагенты.
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| Поле | Тип | Описание |
1648| :------------ | :----------------------- | :------------------------------------------------ |
1649| `task_id` | `str` | Уникальный идентификатор для задачи |
1650| `status` | `TaskNotificationStatus` | Один из `"completed"`, `"failed"` или `"stopped"` |
1651| `output_file` | `str` | Путь к файлу вывода задачи |
1652| `summary` | `str` | Резюме результата задачи |
1653| `uuid` | `str` | Уникальный идентификатор сообщения |
1654| `session_id` | `str` | Идентификатор сеанса |
1655| `tool_use_id` | `str \| None` | Связанный ID использования инструмента |
1656| `usage` | `TaskUsage \| None` | Финальное использование токенов для задачи |
1657
1658## Типы блоков содержимого
1659
1660### `ContentBlock`
1661
1662Тип объединения всех блоков содержимого.
1663
1664```python theme={null}
1665ContentBlock = TextBlock | ThinkingBlock | ToolUseBlock | ToolResultBlock
1666```
1667
1668### `TextBlock`
1669
1670Блок содержимого текста.
1671
1672```python theme={null}
1673@dataclass
1674class TextBlock:
1675 text: str
1676```
1677
1678### `ThinkingBlock`
1679
1680Блок содержимого мышления (для моделей с возможностью мышления).
1681
1682```python theme={null}
1683@dataclass
1684class ThinkingBlock:
1685 thinking: str
1686 signature: str
1687```
1688
1689### `ToolUseBlock`
1690
1691Блок запроса использования инструмента.
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
1703Блок результата выполнения инструмента.
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## Типы ошибок
1714
1715### `ClaudeSDKError`
1716
1717Базовый класс исключения для всех ошибок SDK.
1718
1719```python theme={null}
1720class ClaudeSDKError(Exception):
1721 """Base error for Claude SDK."""
1722```
1723
1724### `CLINotFoundError`
1725
1726Вызывается, когда Claude Code CLI не установлен или не найден.
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
1742Вызывается, когда соединение с Claude Code не удается.
1743
1744```python theme={null}
1745class CLIConnectionError(ClaudeSDKError):
1746 """Failed to connect to Claude Code."""
1747```
1748
1749### `ProcessError`
1750
1751Вызывается, когда процесс Claude Code не работает.
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
1764Вызывается, когда разбор JSON не удается.
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## Типы hooks
1779
1780Для полного руководства по использованию hooks с примерами и общими шаблонами см. [Hooks guide](/ru/agent-sdk/hooks).
1781
1782### `HookEvent`
1783
1784Поддерживаемые типы событий hooks.
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 TypeScript SDK поддерживает дополнительные события hooks, которые еще недоступны в Python: `SessionStart`, `SessionEnd`, `Setup`, `TeammateIdle`, `TaskCompleted`, `ConfigChange`, `WorktreeCreate`, `WorktreeRemove` и `PostToolBatch`.
1803</Note>
1804
1805### `HookCallback`
1806
1807Определение типа для функций обратного вызова hooks.
1808
1809```python theme={null}
1810HookCallback = Callable[[HookInput, str | None, HookContext], Awaitable[HookJSONOutput]]
1811```
1812
1813Параметры:
1814
1815* `input`: Строго типизированный ввод hooks с дискриминированными объединениями на основе `hook_event_name` (см. [`HookInput`](#hook-input))
1816* `tool_use_id`: Дополнительный идентификатор использования инструмента (для hooks, связанных с инструментами)
1817* `context`: Контекст hooks с дополнительной информацией
1818
1819Возвращает [`HookJSONOutput`](#hook-json-output), который может содержать:
1820
1821* `decision`: `"block"` для блокировки действия
1822* `systemMessage`: Системное сообщение для добавления в стенограмму
1823* `hookSpecificOutput`: Вывод, специфичный для hooks
1824
1825### `HookContext`
1826
1827Информация контекста, передаваемая в обратные вызовы hooks.
1828
1829```python theme={null}
1830class HookContext(TypedDict):
1831 signal: Any | None # Future: abort signal support
1832```
1833
1834### `HookMatcher`
1835
1836Конфигурация для сопоставления hooks с определенными событиями или инструментами.
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
1854Тип объединения всех типов ввода hooks. Фактический тип зависит от поля `hook_event_name`.
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
1873Базовые поля, присутствующие во всех типах ввода hooks.
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| Поле | Тип | Описание |
1884| :---------------- | :------------------ | :------------------------------ |
1885| `session_id` | `str` | Текущий идентификатор сеанса |
1886| `transcript_path` | `str` | Путь к файлу стенограммы сеанса |
1887| `cwd` | `str` | Текущий рабочий каталог |
1888| `permission_mode` | `str` (опционально) | Текущий режим разрешений |
1889
1890### `PreToolUseHookInput`
1891
1892Входные данные для событий hooks `PreToolUse`.
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| Поле | Тип | Описание |
1905| :---------------- | :---------------------- | :------------------------------------------------------------------------------ |
1906| `hook_event_name` | `Literal["PreToolUse"]` | Всегда "PreToolUse" |
1907| `tool_name` | `str` | Имя инструмента, который вот-вот будет выполнен |
1908| `tool_input` | `dict[str, Any]` | Входные параметры для инструмента |
1909| `tool_use_id` | `str` | Уникальный идентификатор для этого использования инструмента |
1910| `agent_id` | `str` (опционально) | Идентификатор подагента, присутствует, когда hooks срабатывает внутри подагента |
1911| `agent_type` | `str` (опционально) | Тип подагента, присутствует, когда hooks срабатывает внутри подагента |
1912
1913### `PostToolUseHookInput`
1914
1915Входные данные для событий hooks `PostToolUse`.
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| Поле | Тип | Описание |
1929| :---------------- | :----------------------- | :------------------------------------------------------------------------------ |
1930| `hook_event_name` | `Literal["PostToolUse"]` | Всегда "PostToolUse" |
1931| `tool_name` | `str` | Имя выполненного инструмента |
1932| `tool_input` | `dict[str, Any]` | Использованные входные параметры |
1933| `tool_response` | `Any` | Ответ от выполнения инструмента |
1934| `tool_use_id` | `str` | Уникальный идентификатор для этого использования инструмента |
1935| `agent_id` | `str` (опционально) | Идентификатор подагента, присутствует, когда hooks срабатывает внутри подагента |
1936| `agent_type` | `str` (опционально) | Тип подагента, присутствует, когда hooks срабатывает внутри подагента |
1937
1938### `PostToolUseFailureHookInput`
1939
1940Входные данные для событий hooks `PostToolUseFailure`. Вызывается, когда выполнение инструмента не удается.
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| Поле | Тип | Описание |
1955| :---------------- | :------------------------------ | :------------------------------------------------------------------------------ |
1956| `hook_event_name` | `Literal["PostToolUseFailure"]` | Всегда "PostToolUseFailure" |
1957| `tool_name` | `str` | Имя инструмента, который не удался |
1958| `tool_input` | `dict[str, Any]` | Использованные входные параметры |
1959| `tool_use_id` | `str` | Уникальный идентификатор для этого использования инструмента |
1960| `error` | `str` | Сообщение об ошибке из неудачного выполнения |
1961| `is_interrupt` | `bool` (опционально) | Была ли ошибка вызвана прерыванием |
1962| `agent_id` | `str` (опционально) | Идентификатор подагента, присутствует, когда hooks срабатывает внутри подагента |
1963| `agent_type` | `str` (опционально) | Тип подагента, присутствует, когда hooks срабатывает внутри подагента |
1964
1965### `UserPromptSubmitHookInput`
1966
1967Входные данные для событий hooks `UserPromptSubmit`.
1968
1969```python theme={null}
1970class UserPromptSubmitHookInput(BaseHookInput):
1971 hook_event_name: Literal["UserPromptSubmit"]
1972 prompt: str
1973```
1974
1975| Поле | Тип | Описание |
1976| :---------------- | :---------------------------- | :----------------------------------- |
1977| `hook_event_name` | `Literal["UserPromptSubmit"]` | Всегда "UserPromptSubmit" |
1978| `prompt` | `str` | Отправленная пользователем подсказка |
1979
1980### `StopHookInput`
1981
1982Входные данные для событий hooks `Stop`.
1983
1984```python theme={null}
1985class StopHookInput(BaseHookInput):
1986 hook_event_name: Literal["Stop"]
1987 stop_hook_active: bool
1988```
1989
1990| Поле | Тип | Описание |
1991| :----------------- | :---------------- | :------------------------- |
1992| `hook_event_name` | `Literal["Stop"]` | Всегда "Stop" |
1993| `stop_hook_active` | `bool` | Активен ли hooks остановки |
1994
1995### `SubagentStopHookInput`
1996
1997Входные данные для событий hooks `SubagentStop`.
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| Поле | Тип | Описание |
2009| :---------------------- | :------------------------ | :--------------------------------- |
2010| `hook_event_name` | `Literal["SubagentStop"]` | Всегда "SubagentStop" |
2011| `stop_hook_active` | `bool` | Активен ли hooks остановки |
2012| `agent_id` | `str` | Уникальный идентификатор подагента |
2013| `agent_transcript_path` | `str` | Путь к файлу стенограммы подагента |
2014| `agent_type` | `str` | Тип подагента |
2015
2016### `PreCompactHookInput`
2017
2018Входные данные для событий hooks `PreCompact`.
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| Поле | Тип | Описание |
2028| :-------------------- | :-------------------------- | :----------------------------------------- |
2029| `hook_event_name` | `Literal["PreCompact"]` | Всегда "PreCompact" |
2030| `trigger` | `Literal["manual", "auto"]` | Что вызвало уплотнение |
2031| `custom_instructions` | `str \| None` | Пользовательские инструкции для уплотнения |
2032
2033### `NotificationHookInput`
2034
2035Входные данные для событий hooks `Notification`.
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| Поле | Тип | Описание |
2046| :------------------ | :------------------------ | :------------------------------- |
2047| `hook_event_name` | `Literal["Notification"]` | Всегда "Notification" |
2048| `message` | `str` | Содержимое сообщения уведомления |
2049| `title` | `str` (опционально) | Название уведомления |
2050| `notification_type` | `str` | Тип уведомления |
2051
2052### `SubagentStartHookInput`
2053
2054Входные данные для событий hooks `SubagentStart`.
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| Поле | Тип | Описание |
2064| :---------------- | :------------------------- | :--------------------------------- |
2065| `hook_event_name` | `Literal["SubagentStart"]` | Всегда "SubagentStart" |
2066| `agent_id` | `str` | Уникальный идентификатор подагента |
2067| `agent_type` | `str` | Тип подагента |
2068
2069### `PermissionRequestHookInput`
2070
2071Входные данные для событий hooks `PermissionRequest`. Позволяет hooks программно обрабатывать решения разрешений.
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| Поле | Тип | Описание |
2082| :----------------------- | :----------------------------- | :----------------------------------------- |
2083| `hook_event_name` | `Literal["PermissionRequest"]` | Всегда "PermissionRequest" |
2084| `tool_name` | `str` | Имя инструмента, запрашивающего разрешение |
2085| `tool_input` | `dict[str, Any]` | Входные параметры для инструмента |
2086| `permission_suggestions` | `list[Any]` (опционально) | Предложенные обновления разрешений из CLI |
2087
2088### `HookJSONOutput`
2089
2090Тип объединения для возвращаемых значений обратного вызова hooks.
2091
2092```python theme={null}
2093HookJSONOutput = AsyncHookJSONOutput | SyncHookJSONOutput
2094```
2095
2096#### `SyncHookJSONOutput`
2097
2098Синхронный вывод hooks с полями управления и решения.
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 Используйте `continue_` (с подчеркиванием) в коде Python. Он автоматически преобразуется в `continue` при отправке в CLI.
2118</Note>
2119
2120#### `HookSpecificOutput`
2121
2122`TypedDict`, содержащий имя события hooks и поля, специфичные для события. Форма зависит от значения `hookEventName`. Для полных деталей доступных полей для каждого события hooks см. [Control execution with hooks](/ru/agent-sdk/hooks#outputs).
2123
2124Дискриминированное объединение типов вывода, специфичных для события. Поле `hookEventName` определяет, какие поля действительны.
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
2179Асинхронный вывод hooks, который откладывает выполнение hooks.
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 Используйте `async_` (с подчеркиванием) в коде Python. Он автоматически преобразуется в `async` при отправке в CLI.
2189</Note>
2190
2191### Пример использования hooks
2192
2193Этот пример регистрирует два hooks: один, который блокирует опасные команды bash, такие как `rm -rf /`, и другой, который регистрирует все использование инструментов для аудита. Hooks безопасности работает только на командах Bash (через `matcher`), в то время как hooks логирования работает на всех инструментах.
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## Типы ввода/вывода инструментов
2244
2245Документация схем ввода/вывода для всех встроенных инструментов Claude Code. Хотя Python SDK не экспортирует их как типы, они представляют структуру входов и выходов инструментов в сообщениях.
2246
2247### Agent
2248
2249**Имя инструмента:** `Agent` (ранее `Task`, который все еще принимается как псевдоним)
2250
2251**Ввод:**
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**Вывод:**
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**Имя инструмента:** `AskUserQuestion`
2275
2276Задает пользователю уточняющие вопросы во время выполнения. См. [Handle approvals and user input](/ru/agent-sdk/user-input#handle-clarifying-questions) для деталей использования.
2277
2278**Ввод:**
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**Вывод:**
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**Имя инструмента:** `Bash`
2319
2320**Ввод:**
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**Вывод:**
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**Имя инструмента:** `Monitor`
2345
2346Запускает фоновый скрипт и доставляет каждую строку stdout в Claude как событие, чтобы он мог реагировать без опроса. Monitor следует тем же правилам разрешений, что и Bash. См. [Monitor tool reference](/ru/tools-reference#monitor-tool) для поведения и доступности поставщика.
2347
2348**Ввод:**
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**Вывод:**
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**Имя инструмента:** `Edit`
2372
2373**Ввод:**
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**Вывод:**
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**Имя инструмента:** `Read`
2397
2398**Ввод:**
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**Вывод (текстовые файлы):**
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**Вывод (изображения):**
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**Имя инструмента:** `Write`
2431
2432**Ввод:**
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**Вывод:**
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**Имя инструмента:** `Glob`
2454
2455**Ввод:**
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**Вывод:**
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**Имя инструмента:** `Grep`
2477
2478**Ввод:**
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**Вывод (режим content):**
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**Вывод (режим files\_with\_matches):**
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**Имя инструмента:** `NotebookEdit`
2526
2527**Ввод:**
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**Вывод:**
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**Имя инструмента:** `WebFetch`
2553
2554**Ввод:**
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**Вывод:**
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**Имя инструмента:** `WebSearch`
2577
2578**Ввод:**
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**Вывод:**
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**Имя инструмента:** `TodoWrite`
2601
2602**Ввод:**
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**Вывод:**
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**Имя инструмента:** `BashOutput`
2628
2629**Ввод:**
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**Вывод:**
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**Имя инструмента:** `KillBash`
2651
2652**Ввод:**
2653
2654```python theme={null}
2655{
2656 "shell_id": str # The ID of the background shell to kill
2657}
2658```
2659
2660**Вывод:**
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**Имя инструмента:** `ExitPlanMode`
2672
2673**Ввод:**
2674
2675```python theme={null}
2676{
2677 "plan": str # The plan to run by the user for approval
2678}
2679```
2680
2681**Вывод:**
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**Имя инструмента:** `ListMcpResources`
2693
2694**Ввод:**
2695
2696```python theme={null}
2697{
2698 "server": str | None # Optional server name to filter resources by
2699}
2700```
2701
2702**Вывод:**
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**Имя инструмента:** `ReadMcpResource`
2722
2723**Ввод:**
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**Вывод:**
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## Расширенные функции с ClaudeSDKClient
2744
2745### Построение интерфейса непрерывного разговора
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### Использование hooks для модификации поведения
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### Мониторинг прогресса в реальном времени
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## Пример использования
2950
2951### Базовые операции с файлами (используя 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### Обработка ошибок
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### Режим потоковой передачи с клиентом
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### Использование пользовательских инструментов с 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
3095
3096### `SandboxSettings`
3097
3098Конфигурация для поведения sandbox. Используйте это для включения sandboxing команд и программной настройки ограничений сети.
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| Свойство | Тип | По умолчанию | Описание |
3112| :-------------------------- | :------------------------------------------------------ | :----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3113| `enabled` | `bool` | `False` | Включить режим sandbox для выполнения команд |
3114| `autoAllowBashIfSandboxed` | `bool` | `True` | Автоматически одобрять команды bash, когда sandbox включен |
3115| `excludedCommands` | `list[str]` | `[]` | Команды, которые всегда обходят ограничения sandbox (например, `["docker"]`). Они работают без sandbox автоматически без участия модели |
3116| `allowUnsandboxedCommands` | `bool` | `True` | Разрешить модели запрашивать выполнение команд вне sandbox. Когда `True`, модель может установить `dangerouslyDisableSandbox` в входе инструмента, что переходит к [системе разрешений](#permissions-fallback-for-unsandboxed-commands) |
3117| `network` | [`SandboxNetworkConfig`](#sandbox-network-config) | `None` | Конфигурация sandbox, специфичная для сети |
3118| `ignoreViolations` | [`SandboxIgnoreViolations`](#sandbox-ignore-violations) | `None` | Настройте, какие нарушения sandbox игнорировать |
3119| `enableWeakerNestedSandbox` | `bool` | `False` | Включить более слабый вложенный sandbox для совместимости |
3120
3121#### Пример использования
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**: Опция `allowUnixSockets` может предоставить доступ к мощным системным сервисам. Например, разрешение `/var/run/docker.sock` фактически предоставляет полный доступ к хост-системе через Docker API, обходя изоляцию sandbox. Разрешайте только Unix sockets, которые строго необходимы, и поймите последствия безопасности каждого.
3141</Warning>
3142
3143### `SandboxNetworkConfig`
3144
3145Конфигурация, специфичная для сети, для режима sandbox.
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| Свойство | Тип | По умолчанию | Описание |
3161| :------------------------ | :---------- | :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3162| `allowedDomains` | `list[str]` | `[]` | Имена доменов, к которым могут получить доступ процессы в sandbox |
3163| `deniedDomains` | `list[str]` | `[]` | Имена доменов, к которым процессы в sandbox не могут получить доступ. Имеет приоритет над `allowedDomains` |
3164| `allowManagedDomainsOnly` | `bool` | `False` | Только управляемые параметры: когда установлено в управляемых параметрах, игнорируйте `allowedDomains` из источников неуправляемых параметров. Не имеет эффекта при установке через параметры SDK |
3165| `allowUnixSockets` | `list[str]` | `[]` | Пути Unix socket, к которым процессы могут получить доступ (например, Docker socket) |
3166| `allowAllUnixSockets` | `bool` | `False` | Разрешить доступ ко всем Unix sockets |
3167| `allowLocalBinding` | `bool` | `False` | Разрешить процессам привязываться к локальным портам (например, для dev servers) |
3168| `allowMachLookup` | `list[str]` | `[]` | Только macOS: имена сервисов XPC/Mach для разрешения. Поддерживает завершающий подстановочный знак |
3169| `httpProxyPort` | `int` | `None` | Порт HTTP proxy для сетевых запросов |
3170| `socksProxyPort` | `int` | `None` | Порт SOCKS proxy для сетевых запросов |
3171
3172<Note>
3173 Встроенный прокси sandbox обеспечивает соблюдение списка разрешенных сетей на основе запрашиваемого имени хоста и не завершает и не проверяет трафик TLS, поэтому такие методы, как [domain fronting](https://en.wikipedia.org/wiki/Domain_fronting), потенциально могут его обойти. Подробнее см. в разделе [Ограничения безопасности Sandboxing](/ru/sandboxing#security-limitations) и [Безопасное развертывание](/ru/agent-sdk/secure-deployment#traffic-forwarding) для настройки прокси, завершающего TLS.
3174</Note>
3175
3176### `SandboxIgnoreViolations`
3177
3178Конфигурация для игнорирования определенных нарушений sandbox.
3179
3180```python theme={null}
3181class SandboxIgnoreViolations(TypedDict, total=False):
3182 file: list[str]
3183 network: list[str]
3184```
3185
3186| Свойство | Тип | По умолчанию | Описание |
3187| :-------- | :---------- | :----------- | :----------------------------------------------- |
3188| `file` | `list[str]` | `[]` | Шаблоны путей файлов для игнорирования нарушений |
3189| `network` | `list[str]` | `[]` | Шаблоны сети для игнорирования нарушений |
3190
3191### Fallback разрешений для команд без sandbox
3192
3193Когда `allowUnsandboxedCommands` включен, модель может запросить выполнение команд вне sandbox, установив `dangerouslyDisableSandbox: True` во входе инструмента. Эти запросы переходят к существующей системе разрешений, что означает, что ваш обработчик `can_use_tool` будет вызван, позволяя вам реализовать пользовательскую логику авторизации.
3194
3195<Note>
3196 **`excludedCommands` vs `allowUnsandboxedCommands`:**
3197
3198 * `excludedCommands`: Статический список команд, которые всегда обходят sandbox автоматически (например, `["docker"]`). Модель не имеет контроля над этим.
3199 * `allowUnsandboxedCommands`: Позволяет модели решать во время выполнения, запрашивать ли выполнение без sandbox, установив `dangerouslyDisableSandbox: True` во входе инструмента.
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
3257Этот шаблон позволяет вам:
3258
3259* **Аудит запросов модели**: Логируйте, когда модель запрашивает выполнение без sandbox
3260* **Реализовать allowlists**: Разрешайте только определенные команды работать без sandbox
3261* **Добавить рабочие процессы одобрения**: Требуйте явной авторизации для привилегированных операций
3262
3263<Warning>
3264 Команды, работающие с `dangerouslyDisableSandbox: True`, имеют полный доступ к системе. Убедитесь, что ваш обработчик `can_use_tool` тщательно проверяет эти запросы.
3265
3266 Если `permission_mode` установлен на `bypassPermissions` и `allow_unsandboxed_commands` включен, модель может автономно выполнять команды вне sandbox без каких-либо подсказок одобрения. Эта комбинация фактически позволяет модели молча выходить из изоляции sandbox.
3267</Warning>
3268
3269## См. также
3270
3271* [SDK overview](/ru/agent-sdk/overview) - Общие концепции SDK
3272* [TypeScript SDK reference](/ru/agent-sdk/typescript) - Документация TypeScript SDK
3273* [CLI reference](/ru/cli-reference) - Интерфейс командной строки
3274* [Common workflows](/ru/common-workflows) - Пошаговые руководства
