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 도구를 통해)입니다. 둘 다 canUseTool 콜백을 트리거하며, 이는 응답을 반환할 때까지 실행을 일시 중지합니다. 이는 Claude가 완료되고 다음 메시지를 기다리는 일반적인 대화 턴과는 다릅니다.

명확화 질문의 경우 Claude가 질문과 옵션을 생성합니다. 사용자의 역할은 이를 사용자에게 제시하고 선택 사항을 반환하는 것입니다. 이 흐름에 자신의 질문을 추가할 수 없습니다. 사용자에게 직접 물어봐야 할 사항이 있으면 애플리케이션 로직에서 별도로 수행하십시오.

콜백은 무기한 대기 상태로 유지될 수 있습니다. 콜백이 반환될 때까지 실행이 일시 중지되며, SDK는 쿼리 자체가 취소될 때만 대기를 취소합니다. 사용자가 프로세스가 합리적으로 실행 상태를 유지할 수 있는 것보다 더 오래 응답하는 데 시간이 걸릴 수 있다면, TypeScript SDK는 defer 훅 결정을 지원하므로 프로세스를 종료하고 나중에 지속된 세션에서 재개할 수 있습니다. 이 옵션은 Python SDK에서는 사용할 수 없습니다.

이 가이드는 각 유형의 요청을 감지하고 적절하게 응답하는 방법을 보여줍니다.

Claude가 입력이 필요한 시점 감지

쿼리 옵션에 canUseTool 콜백을 전달합니다. 콜백은 Claude가 사용자 입력이 필요할 때마다 실행되며, 도구 이름과 입력을 인수로 받습니다.

async def handle_tool_request(tool_name, input_data, context):
# 사용자에게 프롬프트하고 허용 또는 거부 반환
...


options = ClaudeAgentOptions(can_use_tool=handle_tool_request)

콜백은 두 가지 경우에 실행됩니다.

  1. 도구가 승인 필요: Claude가 권한 규칙 또는 모드에 의해 자동 승인되지 않은 도구를 사용하려고 합니다. 도구에 대해 tool_name을 확인합니다(예: "Bash", "Write").
  2. Claude가 질문함: Claude가 AskUserQuestion 도구를 호출합니다. tool_name == "AskUserQuestion"을 확인하여 다르게 처리합니다. tools 배열을 지정하는 경우 이것이 작동하려면 AskUserQuestion을 포함하십시오. 자세한 내용은 명확화 질문 처리를 참조하십시오.

도구 승인 요청 처리

쿼리 옵션에 canUseTool 콜백을 전달하면, Claude가 자동 승인되지 않은 도구를 사용하려고 할 때 실행됩니다. 콜백은 세 가지 인수를 받습니다.

인수 설명
toolName Claude가 사용하려는 도구의 이름(예: "Bash", "Write", "Edit")
input Claude가 도구에 전달하는 매개변수입니다. 내용은 도구에 따라 다릅니다.
options (TS) / context (Python) 선택적 suggestions(재프롬프트를 피하기 위한 제안된 PermissionUpdate 항목)과 취소 신호를 포함한 추가 컨텍스트입니다. TypeScript에서 signalAbortSignal입니다. Python에서 신호 필드는 향후 사용을 위해 예약되어 있습니다. Python의 경우 ToolPermissionContext를 참조하십시오.

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가 각 작업을 시도할 때 콜백은 도구 요청을 터미널에 인쇄하고 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")


# 필수 해결 방법: 더미 훅이 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 이외의 모든 입력이 거부로 처리되는 y/n 흐름을 사용합니다. 실제로는 사용자가 요청을 수정하거나, 피드백을 제공하거나, Claude를 완전히 리디렉션할 수 있는 더 풍부한 UI를 구축할 수 있습니다. 응답할 수 있는 모든 방법은 도구 요청에 응답을 참조하십시오.

도구 요청에 응답

콜백은 두 가지 응답 유형 중 하나를 반환합니다.

응답 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을 변경하지 않고 전달하면 도구가 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 도구를 호출합니다. 이는 toolNameAskUserQuestion으로 설정된 canUseTool 콜백을 트리거합니다. 입력에는 Claude의 질문이 객관식 옵션으로 포함되어 있으며, 이를 사용자에게 표시하고 선택 사항을 반환합니다.

다음 단계는 명확화 질문을 처리하는 방법을 보여줍니다.

1

canUseTool 콜백 전달

쿼리 옵션에 canUseTool 콜백을 전달합니다. 기본적으로 AskUserQuestion을 사용할 수 있습니다. Claude의 기능을 제한하기 위해 tools 배열을 지정하는 경우(예: Read, GlobGrep만 있는 읽기 전용 에이전트), 그 배열에 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 감지

콜백에서 toolNameAskUserQuestion과 같은지 확인하여 다른 도구와 다르게 처리합니다.

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

질문 입력 구문 분석

입력에는 questions 배열의 Claude 질문이 포함됩니다. 각 질문에는 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"],
},
}
)

질문 형식

입력에는 questions 배열의 Claude 생성 질문이 포함됩니다. 각 질문에는 다음 필드가 있습니다.

필드 설명
question 표시할 전체 질문 텍스트
header 질문의 짧은 레이블(최대 12자)
options 각각 labeldescription이 있는 2-4개 선택 사항의 배열입니다. TypeScript: 선택적으로 preview(아래 참조)
multiSelect true인 경우 사용자가 여러 옵션을 선택할 수 있습니다.

콜백이 받는 구조:

{
  "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>을 거부합니다.)

형식은 세션의 모든 질문에 적용됩니다. 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>"
}

응답 형식

각 질문의 question 필드를 선택된 옵션의 label에 매핑하는 answers 객체를 반환합니다.

필드 설명
questions 원본 질문 배열을 전달합니다(도구 처리에 필수).
answers 키가 질문 텍스트이고 값이 선택된 레이블인 객체입니다.

다중 선택 질문의 경우 레이블 배열을 전달하거나 ", "로 조인합니다. 자유 텍스트 입력의 경우 사용자의 사용자 정의 텍스트를 직접 사용합니다.

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

자유 텍스트 입력 지원

Claude의 사전 정의된 옵션이 항상 사용자가 원하는 것을 다루지는 않습니다. 사용자가 자신의 답변을 입력하도록 허용하려면:

  • Claude의 옵션 후에 추가 "Other" 선택을 표시하여 텍스트 입력을 허용합니다.
  • 사용자의 사용자 정의 텍스트를 답변 값으로 사용합니다("Other"라는 단어가 아님).

전체 구현은 아래의 완전한 예제를 참조하십시오.

완전한 예제

Claude는 진행하기 위해 사용자 입력이 필요할 때 명확화 질문을 합니다. 예를 들어 모바일 앱의 기술 스택을 결정하는 데 도움을 달라는 요청을 받으면 Claude는 크로스 플랫폼 대 네이티브, 백엔드 선호도 또는 대상 플랫폼에 대해 물어볼 수 있습니다. 이러한 질문은 Claude가 추측하기보다는 사용자의 선호도와 일치하는 결정을 내리는 데 도움이 됩니다.

이 예제는 터미널 애플리케이션에서 이러한 질문을 처리합니다. 각 단계에서 발생하는 일은 다음과 같습니다.

  1. 요청 라우팅: 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",
},
}


# 필수 해결 방법: 더미 훅이 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 호출은 각각 2-4개 옵션이 있는 1-4개 질문을 지원합니다.

사용자 입력을 얻는 다른 방법

canUseTool 콜백과 AskUserQuestion 도구는 대부분의 승인 및 명확화 시나리오를 다루지만, SDK는 사용자로부터 입력을 얻는 다른 방법을 제공합니다.

스트리밍 입력

다음이 필요할 때 스트리밍 입력을 사용하십시오.

  • 에이전트 중간에 중단: Claude가 작업 중일 때 취소 신호를 보내거나 방향을 변경합니다.
  • 추가 컨텍스트 제공: Claude가 물어볼 때까지 기다리지 않고 필요한 정보를 추가합니다.
  • 채팅 인터페이스 구축: 장시간 실행되는 작업 중에 사용자가 후속 메시지를 보낼 수 있습니다.

스트리밍 입력은 사용자가 승인 체크포인트에서만이 아니라 실행 전체에서 에이전트와 상호 작용하는 대화형 UI에 이상적입니다.

사용자 정의 도구

다음이 필요할 때 사용자 정의 도구를 사용하십시오.

  • 구조화된 입력 수집: AskUserQuestion의 객관식 형식을 넘어서는 양식, 마법사 또는 다단계 워크플로우를 구축합니다.
  • 외부 승인 시스템 통합: 기존 티켓팅, 워크플로우 또는 승인 플랫폼에 연결합니다.
  • 도메인별 상호 작용 구현: 코드 검토 인터페이스 또는 배포 체크리스트와 같이 애플리케이션의 필요에 맞는 도구를 만듭니다.

사용자 정의 도구는 상호 작용을 완전히 제어할 수 있지만 기본 제공 canUseTool 콜백을 사용하는 것보다 더 많은 구현 작업이 필요합니다.

관련 리소스