SpyBara
Go Premium

agent-sdk/user-input.md 2026-05-08 22:00 UTC to 2026-05-09 04:57 UTC

810 added, 0 removed.

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

Обработка одобрений и пользовательского ввода

Выводите запросы на одобрение Claude и уточняющие вопросы пользователям, а затем возвращайте их решения в SDK.

Во время работы над задачей Claude иногда нужно проверить информацию у пользователей. Ему может потребоваться разрешение перед удалением файлов или нужно спросить, какую базу данных использовать для нового проекта. Ваше приложение должно выводить эти запросы пользователям, чтобы Claude мог продолжить работу с их вводом.

Claude запрашивает пользовательский ввод в двух ситуациях: когда ему нужно разрешение на использование инструмента (например, удаление файлов или запуск команд) и когда у него есть уточняющие вопросы (через инструмент AskUserQuestion). Оба случая запускают ваш callback canUseTool, который приостанавливает выполнение до получения ответа. Это отличается от обычных диалоговых ходов, где Claude завершает работу и ждёт вашего следующего сообщения.

Для уточняющих вопросов Claude генерирует вопросы и варианты ответов. Ваша роль — представить их пользователям и вернуть их выборы. Вы не можете добавлять свои собственные вопросы в этот процесс; если вам нужно что-то спросить у пользователей, сделайте это отдельно в логике вашего приложения.

Callback может оставаться в ожидании неопределённо долго. Выполнение остаётся приостановленным до возврата вашего callback, и SDK отменяет ожидание только при отмене самого запроса. Если пользователь может ответить дольше, чем ваш процесс может разумно оставаться запущенным, TypeScript SDK поддерживает hook defer, который позволяет процессу выйти и возобновиться позже из сохранённой сессии; эта опция недоступна в Python SDK.

Это руководство показывает, как обнаружить каждый тип запроса и ответить надлежащим образом.

Обнаружение, когда Claude нуждается в вводе

Передайте callback canUseTool в параметры вашего запроса. Callback срабатывает всякий раз, когда Claude нуждается в пользовательском вводе, получая имя инструмента и ввод в качестве аргументов:

async def handle_tool_request(tool_name, input_data, context):
# Запросить у пользователя и вернуть разрешение или отказ
...


options = ClaudeAgentOptions(can_use_tool=handle_tool_request)

Callback срабатывает в двух случаях:

  1. Инструмент требует одобрения: Claude хочет использовать инструмент, который не одобрен автоматически правилами разрешений или режимами. Проверьте tool_name на имя инструмента (например, "Bash", "Write").
  2. Claude задаёт вопрос: Claude вызывает инструмент AskUserQuestion. Проверьте, равен ли tool_name == "AskUserQuestion", чтобы обработать его иначе. Если вы указываете массив tools, включите AskUserQuestion для работы этого функционала. Подробнее см. Обработка уточняющих вопросов.

Обработка запросов на одобрение инструмента

После передачи callback canUseTool в параметры вашего запроса он срабатывает, когда Claude хочет использовать инструмент, который не одобрен автоматически. Ваш callback получает три аргумента:

Аргумент Описание
toolName Имя инструмента, который Claude хочет использовать (например, "Bash", "Write", "Edit")
input Параметры, которые Claude передаёт инструменту. Содержимое варьируется в зависимости от инструмента.
options (TS) / context (Python) Дополнительный контекст, включая опциональные suggestions (предложенные записи PermissionUpdate для избежания повторного запроса) и сигнал отмены. В TypeScript signal — это AbortSignal; в Python поле signal зарезервировано для будущего использования. Подробнее см. ToolPermissionContext для Python.

Объект input содержит параметры, специфичные для инструмента. Распространённые примеры:

Инструмент Поля ввода
Bash command, description, timeout
Write file_path, content
Edit file_path, old_string, new_string
Read file_path, offset, limit

Полные схемы ввода см. в справочнике SDK: Python | TypeScript.

Вы можете отобразить эту информацию пользователю, чтобы он мог решить, разрешить или отклонить действие, а затем вернуть соответствующий ответ.

Следующий пример просит Claude создать и удалить тестовый файл. Когда Claude пытается выполнить каждую операцию, callback выводит запрос инструмента в терминал и запрашивает одобрение y/n.

import asyncio

from claude_agent_sdk import ClaudeAgentOptions, ResultMessage, query
from claude_agent_sdk.types import (
HookMatcher,
PermissionResultAllow,
PermissionResultDeny,
ToolPermissionContext,
)


async def can_use_tool(
tool_name: str, input_data: dict, context: ToolPermissionContext
) -> PermissionResultAllow | PermissionResultDeny:
# Отобразить запрос инструмента
print(f"\nTool: {tool_name}")
if tool_name == "Bash":
print(f"Command: {input_data.get('command')}")
if input_data.get("description"):
print(f"Description: {input_data.get('description')}")
else:
print(f"Input: {input_data}")

# Получить одобрение пользователя
response = input("Allow this action? (y/n): ")

# Вернуть разрешение или отказ на основе ответа пользователя
if response.lower() == "y":
# Разрешить: инструмент выполняется с исходным (или изменённым) вводом
return PermissionResultAllow(updated_input=input_data)
else:
# Отклонить: инструмент не выполняется, Claude видит сообщение
return PermissionResultDeny(message="User denied this action")


# Требуемый обходной путь: фиктивный hook держит поток открытым для can_use_tool
async def dummy_hook(input_data, tool_use_id, context):
return {"continue_": True}


async def prompt_stream():
yield {
"type": "user",
"message": {
"role": "user",
"content": "Create a test file in /tmp and then delete it",
},
}


async def main():
async for message in query(
prompt=prompt_stream(),
options=ClaudeAgentOptions(
can_use_tool=can_use_tool,
hooks={"PreToolUse": [HookMatcher(matcher=None, hooks=[dummy_hook])]},
),
):
if isinstance(message, ResultMessage) and message.subtype == "success":
print(message.result)


asyncio.run(main())

Этот пример использует поток y/n, где любой ввод, отличный от y, рассматривается как отказ. На практике вы можете создать более богатый пользовательский интерфейс, который позволяет пользователям изменять запрос, предоставлять обратную связь или полностью перенаправлять Claude. Подробнее см. Ответ на запросы инструментов.

Ответ на запросы инструментов

Ваш callback возвращает один из двух типов ответов:

Ответ Python TypeScript
Разрешить PermissionResultAllow(updated_input=...) { behavior: "allow", updatedInput }
Отклонить PermissionResultDeny(message=...) { behavior: "deny", message }

При разрешении передайте ввод инструмента (исходный или изменённый). При отклонении предоставьте сообщение, объясняющее причину. Claude видит это сообщение и может скорректировать свой подход.

from claude_agent_sdk.types import PermissionResultAllow, PermissionResultDeny

# Разрешить выполнение инструмента
return PermissionResultAllow(updated_input=input_data)

# Заблокировать инструмент
return PermissionResultDeny(message="User rejected this action")

Помимо разрешения или отклонения, вы можете изменить ввод инструмента или предоставить контекст, который помогает Claude скорректировать свой подход:

  • Одобрить: позволить инструменту выполниться так, как запросил Claude
  • Одобрить с изменениями: изменить ввод перед выполнением (например, санитизировать пути, добавить ограничения)
  • Отклонить: заблокировать инструмент и объяснить Claude причину
  • Предложить альтернативу: заблокировать, но направить Claude к тому, что хочет пользователь
  • Полностью перенаправить: использовать потоковый ввод для отправки Claude совершенно новой инструкции

Пользователь одобряет действие как есть. Пропустите input из вашего callback без изменений и инструмент выполнится ровно так, как запросил Claude.

async def can_use_tool(tool_name, input_data, context):
print(f"Claude wants to use {tool_name}")
approved = await ask_user("Allow this action?")

if approved:
return PermissionResultAllow(updated_input=input_data)
return PermissionResultDeny(message="User declined")

Обработка уточняющих вопросов

Когда Claude нуждается в дополнительном направлении для задачи с несколькими допустимыми подходами, он вызывает инструмент AskUserQuestion. Это запускает ваш callback canUseTool с toolName, установленным на AskUserQuestion. Ввод содержит вопросы Claude в виде вариантов с множественным выбором, которые вы выводите пользователю и возвращаете их выборы.

Следующие шаги показывают, как обработать уточняющие вопросы:

1

Передайте callback canUseTool

Передайте callback canUseTool в параметры вашего запроса. По умолчанию AskUserQuestion доступен. Если вы указываете массив tools для ограничения возможностей Claude (например, агент только для чтения с только Read, Glob и Grep), включите AskUserQuestion в этот массив. В противном случае Claude не сможет задавать уточняющие вопросы:

async for message in query(
prompt="Analyze this codebase",
options=ClaudeAgentOptions(
# Включите AskUserQuestion в ваш список инструментов
tools=["Read", "Glob", "Grep", "AskUserQuestion"],
can_use_tool=can_use_tool,
),
):
print(message)
2

Обнаружьте AskUserQuestion

В вашем callback проверьте, равен ли toolName AskUserQuestion, чтобы обработать его иначе, чем другие инструменты:

async def can_use_tool(tool_name: str, input_data: dict, context):
if tool_name == "AskUserQuestion":
# Ваша реализация для сбора ответов от пользователя
return await handle_clarifying_questions(input_data)
# Обработайте другие инструменты нормально
return await prompt_for_approval(tool_name, input_data)
3

Разберите ввод вопроса

Ввод содержит вопросы Claude в массиве questions. Каждый вопрос имеет question (текст для отображения), options (варианты выбора) и multiSelect (разрешены ли множественные выборы):

{
"questions": [
{
"question": "How should I format the output?",
"header": "Format",
"options": [
{ "label": "Summary", "description": "Brief overview" },
{ "label": "Detailed", "description": "Full explanation" }
],
"multiSelect": false
},
{
"question": "Which sections should I include?",
"header": "Sections",
"options": [
{ "label": "Introduction", "description": "Opening context" },
{ "label": "Conclusion", "description": "Final summary" }
],
"multiSelect": true
}
]
}

Полное описание полей см. в Формат вопроса.

4

Соберите ответы от пользователя

Представьте вопросы пользователю и соберите их выборы. Как вы это сделаете, зависит от вашего приложения: терминальный запрос, веб-форма, мобильный диалог и т. д.

5

Верните ответы Claude

Создайте объект answers как запись, где каждый ключ — это текст question, а каждое значение — это label выбранного варианта:

Из объекта вопроса Используйте как
Поле question (например, "How should I format the output?") Ключ
Поле label выбранного варианта (например, "Summary") Значение

Для вопросов с множественным выбором передайте массив меток или объедините их с ", ". Если вы поддерживаете свободный ввод текста, используйте пользовательский текст пользователя как значение.

return PermissionResultAllow(
updated_input={
"questions": input_data.get("questions", []),
"answers": {
"How should I format the output?": "Summary",
"Which sections should I include?": ["Introduction", "Conclusion"],
},
}
)

Формат вопроса

Ввод содержит сгенерированные Claude вопросы в массиве questions. Каждый вопрос имеет эти поля:

Поле Описание
question Полный текст вопроса для отображения
header Короткая метка для вопроса (максимум 12 символов)
options Массив из 2-4 вариантов выбора, каждый с label и description. TypeScript: опционально preview (см. ниже)
multiSelect Если true, пользователи могут выбрать несколько вариантов

Структура, которую получает ваш callback:

{
  "questions": [
    {
      "question": "How should I format the output?",
      "header": "Format",
      "options": [
        { "label": "Summary", "description": "Brief overview of key points" },
        { "label": "Detailed", "description": "Full explanation with examples" }
      ],
      "multiSelect": false
    }
  ]
}

Предпросмотры вариантов (TypeScript)

toolConfig.askUserQuestion.previewFormat добавляет поле preview к каждому варианту, чтобы ваше приложение могло показать визуальный макет рядом с меткой. Без этого параметра Claude не генерирует предпросмотры и поле отсутствует.

previewFormat preview содержит
не установлено (по умолчанию) Поле отсутствует. Claude не генерирует предпросмотры.
"markdown" ASCII-арт и блоки кода в ограде
"html" Стилизованный фрагмент <div> (SDK отклоняет <script>, <style> и <!DOCTYPE> перед запуском вашего callback)

Формат применяется ко всем вопросам в сессии. Claude включает preview на варианты, где визуальное сравнение помогает (выбор макета, цветовые схемы) и опускает его, где оно не помогает (да/нет подтверждения, только текстовые варианты). Проверьте undefined перед рендерингом.

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

for await (const message of query({
  prompt: "Help me choose a card layout",
  options: {
    toolConfig: {
      askUserQuestion: { previewFormat: "html" }
    },
    canUseTool: async (toolName, input) => {
      // input.questions[].options[].preview — это HTML-строка или undefined
      return { behavior: "allow", updatedInput: input };
    }
  }
})) {
  // ...
}

Вариант с HTML-предпросмотром:

{
  "label": "Compact",
  "description": "Title and metric value only",
  "preview": "<div style=\"padding:12px;border:1px solid #ddd;border-radius:8px\"><div style=\"font-size:12px;color:#666\">Active users</div><div style=\"font-size:28px;font-weight:600\">1,284</div></div>"
}

Формат ответа

Верните объект answers, сопоставляющий поле question каждого вопроса с label выбранного варианта:

Поле Описание
questions Пропустите исходный массив вопросов (требуется для обработки инструмента)
answers Объект, где ключи — это текст вопроса, а значения — это выбранные метки

Для вопросов с множественным выбором передайте массив меток или объедините их с ", ". Для свободного ввода текста используйте пользовательский текст пользователя напрямую.

{
  "questions": [
    // ...
  ],
  "answers": {
    "How should I format the output?": "Summary",
    "Which sections should I include?": ["Introduction", "Conclusion"]
  }
}

Поддержка свободного ввода текста

Предопределённые варианты Claude не всегда охватывают то, что хотят пользователи. Чтобы позволить пользователям вводить свой собственный ответ:

  • Отобразите дополнительный выбор "Other" после вариантов Claude, который принимает текстовый ввод
  • Используйте пользовательский текст пользователя как значение ответа (не слово "Other")

Полную реализацию см. в полном примере ниже.

Полный пример

Claude задаёт уточняющие вопросы, когда ему нужен пользовательский ввод для продолжения. Например, когда его просят помочь решить, какой технологический стек использовать для мобильного приложения, Claude может спросить о кроссплатформенности vs нативности, предпочтениях бэкенда или целевых платформах. Эти вопросы помогают Claude принимать решения, которые соответствуют предпочтениям пользователя, а не угадывать.

Этот пример обрабатывает эти вопросы в терминальном приложении. Вот что происходит на каждом шаге:

  1. Маршрутизация запроса: callback canUseTool проверяет, равно ли имя инструмента "AskUserQuestion" и маршрутизирует к выделенному обработчику
  2. Отображение вопросов: обработчик проходит по массиву questions и выводит каждый вопрос с пронумерованными вариантами
  3. Сбор ввода: пользователь может ввести номер для выбора варианта или ввести свободный текст напрямую (например, "jquery", "i don't know")
  4. Сопоставление ответов: код проверяет, является ли ввод числовым (использует метку варианта) или свободным текстом (использует текст напрямую)
  5. Возврат Claude: ответ включает как исходный массив questions, так и сопоставление answers
import asyncio

from claude_agent_sdk import ClaudeAgentOptions, ResultMessage, query
from claude_agent_sdk.types import HookMatcher, PermissionResultAllow


def parse_response(response: str, options: list) -> str:
"""Разберите пользовательский ввод как номер(а) варианта или свободный текст."""
try:
indices = [int(s.strip()) - 1 for s in response.split(",")]
labels = [options[i]["label"] for i in indices if 0 <= i < len(options)]
return ", ".join(labels) if labels else response
except ValueError:
return response


async def handle_ask_user_question(input_data: dict) -> PermissionResultAllow:
"""Отобразите вопросы Claude и соберите ответы пользователя."""
answers = {}

for q in input_data.get("questions", []):
print(f"\n{q['header']}: {q['question']}")

options = q["options"]
for i, opt in enumerate(options):
print(f"  {i + 1}. {opt['label']} - {opt['description']}")
if q.get("multiSelect"):
print("  (Enter numbers separated by commas, or type your own answer)")
else:
print("  (Enter a number, or type your own answer)")

response = input("Your choice: ").strip()
answers[q["question"]] = parse_response(response, options)

return PermissionResultAllow(
updated_input={
"questions": input_data.get("questions", []),
"answers": answers,
}
)


async def can_use_tool(
tool_name: str, input_data: dict, context
) -> PermissionResultAllow:
# Маршрутизируйте AskUserQuestion к нашему обработчику вопросов
if tool_name == "AskUserQuestion":
return await handle_ask_user_question(input_data)
# Автоматически одобрите другие инструменты для этого примера
return PermissionResultAllow(updated_input=input_data)


async def prompt_stream():
yield {
"type": "user",
"message": {
"role": "user",
"content": "Help me decide on the tech stack for a new mobile app",
},
}


# Требуемый обходной путь: фиктивный hook держит поток открытым для can_use_tool
async def dummy_hook(input_data, tool_use_id, context):
return {"continue_": True}


async def main():
async for message in query(
prompt=prompt_stream(),
options=ClaudeAgentOptions(
can_use_tool=can_use_tool,
hooks={"PreToolUse": [HookMatcher(matcher=None, hooks=[dummy_hook])]},
),
):
if isinstance(message, ResultMessage) and message.subtype == "success":
print(message.result)


asyncio.run(main())

Ограничения

  • Подагенты: AskUserQuestion в настоящее время недоступен в подагентах, порождённых через инструмент Agent
  • Ограничения вопросов: каждый вызов AskUserQuestion поддерживает 1-4 вопроса с 2-4 вариантами каждый

Другие способы получить пользовательский ввод

Callback canUseTool и инструмент AskUserQuestion охватывают большинство сценариев одобрения и уточнения, но SDK предлагает другие способы получить ввод от пользователей:

Потоковый ввод

Используйте потоковый ввод когда вам нужно:

  • Прервать агента в середине задачи: отправить сигнал отмены или изменить направление, пока Claude работает
  • Предоставить дополнительный контекст: добавить информацию, которая нужна Claude, без ожидания, пока он спросит
  • Создать интерфейсы чата: позволить пользователям отправлять последующие сообщения во время долгоживущих операций

Потоковый ввод идеален для разговорных пользовательских интерфейсов, где пользователи взаимодействуют с агентом на протяжении всего выполнения, а не только в контрольных точках одобрения.

Пользовательские инструменты

Используйте пользовательские инструменты когда вам нужно:

  • Собрать структурированный ввод: создать формы, мастера или многошаговые рабочие процессы, которые выходят за рамки формата множественного выбора AskUserQuestion
  • Интегрировать внешние системы одобрения: подключиться к существующим системам тикетов, рабочих процессов или одобрения
  • Реализовать взаимодействия, специфичные для домена: создать инструменты, адаптированные к потребностям вашего приложения, такие как интерфейсы проверки кода или контрольные списки развёртывания

Пользовательские инструменты дают вам полный контроль над взаимодействием, но требуют больше работы по реализации, чем использование встроенного callback canUseTool.

Связанные ресурсы