Loading...
    • Guia do Desenvolvedor
    • Referência da API
    • MCP
    • Recursos
    • Notas de lançamento
    Search...
    ⌘K
    Primeiros passos
    Introdução ao ClaudeInício rápido
    Modelos e preços
    Visão geral dos modelosEscolhendo um modeloNovidades no Claude 4.5Migrando para Claude 4.5Descontinuação de modelosPreços
    Construir com Claude
    Visão geral de recursosUsando a API MessagesJanelas de contextoMelhores práticas de prompting
    Capacidades
    Cache de promptEdição de contextoPensamento estendidoEsforçoStreaming de mensagensProcessamento em loteCitaçõesSuporte multilíngueContagem de tokensEmbeddingsVisãoSuporte a PDFAPI de arquivosResultados de buscaSaídas estruturadas
    Ferramentas
    Visão geralComo implementar o uso de ferramentasStreaming de ferramentas granularFerramenta BashFerramenta de execução de códigoChamada de ferramenta programáticaFerramenta de uso do computadorFerramenta de editor de textoFerramenta de busca na webFerramenta de pesquisa na webFerramenta de memóriaFerramenta de busca de ferramentas
    Habilidades do agente
    Visão geralInício rápidoMelhores práticasUsando habilidades com a API
    SDK do agente
    Visão geralInício rápidoSDK TypeScriptTypeScript V2 (preview)SDK PythonGuia de migração
    MCP na API
    Conector MCPServidores MCP remotos
    Claude em plataformas de terceiros
    Amazon BedrockMicrosoft FoundryVertex AI
    Engenharia de prompts
    Visão geralGerador de promptsUsar modelos de promptsMelhorador de promptsSeja claro e diretoUse exemplos (prompting multishot)Deixe Claude pensar (CoT)Use tags XMLDê um papel ao Claude (prompts do sistema)Preencha a resposta do ClaudeEncadeie prompts complexosDicas de contexto longoDicas de pensamento estendido
    Testar e avaliar
    Definir critérios de sucessoDesenvolver casos de testeUsando a ferramenta de avaliaçãoReduzindo latência
    Fortalecer proteções
    Reduzir alucinaçõesAumentar consistência de saídaMitigar jailbreaksRecusas de streamingReduzir vazamento de promptManter Claude em personagem
    Administração e monitoramento
    Visão geral da API de administraçãoAPI de uso e custoAPI de análise de código Claude
    Console
    Log in
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...
    Loading...

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Partners

    • Amazon Bedrock
    • Google Cloud's Vertex AI

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Help and security

    • Availability
    • Status
    • Support
    • Discord

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy
    SDK do agente

    Referência do Agent SDK - Python

    Referência completa da API para o Agent SDK Python, incluindo todas as funções, tipos e classes.
    • Instalação
    • Escolhendo Entre query() e ClaudeSDKClient
    • Comparação Rápida
    • Quando Usar query() (Nova Sessão Cada Vez)
    • Quando Usar ClaudeSDKClient (Conversa Contínua)
    • Funções
    • query()
    • tool()
    • create_sdk_mcp_server()
    • Classes
    • ClaudeSDKClient
    • Tipos
    • SdkMcpTool
    • ClaudeAgentOptions
    • OutputFormat
    • SystemPromptPreset
    • SettingSource
    • AgentDefinition
    • PermissionMode
    • McpSdkServerConfig
    • McpServerConfig
    • SdkPluginConfig
    • Tipos de Mensagem
    • Message
    • UserMessage
    • AssistantMessage
    • SystemMessage
    • ResultMessage
    • Tipos de Bloco de Conteúdo
    • ContentBlock
    • TextBlock
    • ThinkingBlock
    • ToolUseBlock
    • ToolResultBlock
    • Tipos de Erro
    • ClaudeSDKError
    • CLINotFoundError
    • CLIConnectionError
    • ProcessError
    • CLIJSONDecodeError
    • Tipos de Hook
    • HookEvent
    • HookCallback
    • HookContext
    • HookMatcher
    • Exemplo de Uso de Hook
    • Tipos de Entrada/Saída de Ferramenta
    • Task
    • Bash
    • Edit
    • Read
    • Write
    • Glob
    • Grep
    • NotebookEdit
    • WebFetch
    • WebSearch
    • TodoWrite
    • BashOutput
    • KillBash
    • ExitPlanMode
    • ListMcpResources
    • ReadMcpResource
    • Recursos Avançados com ClaudeSDKClient
    • Construindo uma Interface de Conversa Contínua
    • Usando Hooks para Modificação de Comportamento
    • Monitoramento de Progresso em Tempo Real
    • Exemplo de Uso
    • Operações básicas de arquivo (usando query)
    • Tratamento de erros
    • Modo de streaming com cliente
    • Usando ferramentas personalizadas com ClaudeSDKClient
    • Configuração de Sandbox
    • SandboxSettings
    • SandboxNetworkConfig
    • SandboxIgnoreViolations
    • Fallback de Permissões para Comandos Sem Sandbox
    • Veja também

    Instalação

    pip install claude-agent-sdk

    Escolhendo Entre query() e ClaudeSDKClient

    O SDK Python fornece duas maneiras de interagir com Claude Code:

    Comparação Rápida

    Recursoquery()ClaudeSDKClient
    SessãoCria nova sessão cada vezReutiliza a mesma sessão
    ConversaTroca únicaMúltiplas trocas no mesmo contexto
    ConexãoGerenciada automaticamenteControle manual
    Entrada em Streaming✅ Suportado✅ Suportado
    Interrupções❌ Não suportado✅ Suportado
    Hooks❌ Não suportado✅ Suportado
    Ferramentas Personalizadas❌ Não suportado✅ Suportado
    Continuar Chat❌ Nova sessão cada vez✅ Mantém conversa
    Caso de UsoTarefas únicasConversas contínuas

    Quando Usar query() (Nova Sessão Cada Vez)

    Melhor para:

    • Perguntas únicas onde você não precisa do histórico de conversa
    • Tarefas independentes que não requerem contexto de trocas anteriores
    • Scripts de automação simples
    • Quando você quer um novo começo cada vez

    Quando Usar ClaudeSDKClient (Conversa Contínua)

    Melhor para:

    • Continuar conversas - Quando você precisa que Claude se lembre do contexto
    • Perguntas de acompanhamento - Construindo sobre respostas anteriores
    • Aplicações interativas - Interfaces de chat, REPLs
    • Lógica orientada por resposta - Quando a próxima ação depende da resposta de Claude
    • Controle de sessão - Gerenciando o ciclo de vida da conversa explicitamente

    Funções

    query()

    Cria uma nova sessão para cada interação com Claude Code. Retorna um iterador assíncrono que produz mensagens conforme chegam. Cada chamada para query() começa do zero sem memória de interações anteriores.

    async def query(
        *,
        prompt: str | AsyncIterable[dict[str, Any]],
        options: ClaudeAgentOptions | None = None
    ) -> AsyncIterator[Message]

    Parâmetros

    ParâmetroTipoDescrição
    promptstr | AsyncIterable[dict]O prompt de entrada como uma string ou iterável assíncrono para modo de streaming
    optionsClaudeAgentOptions | NoneObjeto de configuração opcional (padrão para ClaudeAgentOptions() se None)

    Retorna

    Retorna um AsyncIterator[Message] que produz mensagens da conversa.

    Exemplo - Com opções

    
    import asyncio
    from claude_agent_sdk import query, ClaudeAgentOptions
    
    async def main():
        options = ClaudeAgentOptions(
            system_prompt="You are an expert Python developer",
            permission_mode='acceptEdits',
            cwd="/home/user/project"
        )
    
        async for message in query(
            prompt="Create a Python web server",
            options=options
        ):
            print(message)
    
    
    asyncio.run(main())

    tool()

    Decorador para definir ferramentas MCP com segurança de tipo.

    def tool(
        name: str,
        description: str,
        input_schema: type | dict[str, Any]
    ) -> Callable[[Callable[[Any], Awaitable[dict[str, Any]]]], SdkMcpTool[Any]]

    Parâmetros

    ParâmetroTipoDescrição
    namestrIdentificador único para a ferramenta
    descriptionstrDescrição legível por humanos do que a ferramenta faz
    input_schematype | dict[str, Any]Schema definindo os parâmetros de entrada da ferramenta (veja abaixo)

    Opções de Input Schema

    1. Mapeamento de tipo simples (recomendado):

      {"text": str, "count": int, "enabled": bool}
    2. Formato JSON Schema (para validação complexa):

      {
          "type": "object",
          "properties": {
              "text": {"type": "string"},
              "count": {"type": "integer", "minimum": 0}
          },
          "required": ["text"]
      }

    Retorna

    Uma função decoradora que envolve a implementação da ferramenta e retorna uma instância SdkMcpTool.

    Exemplo

    from claude_agent_sdk import tool
    from typing import Any
    
    @tool("greet", "Greet a user", {"name": str})
    async def greet(args: dict[str, Any]) -> dict[str, Any]:
        return {
            "content": [{
                "type": "text",
                "text": f"Hello, {args['name']}!"
            }]
        }

    create_sdk_mcp_server()

    Cria um servidor MCP em processo que é executado dentro de sua aplicação Python.

    def create_sdk_mcp_server(
        name: str,
        version: str = "1.0.0",
        tools: list[SdkMcpTool[Any]] | None = None
    ) -> McpSdkServerConfig

    Parâmetros

    ParâmetroTipoPadrãoDescrição
    namestr-Identificador único para o servidor
    versionstr"1.0.0"String de versão do servidor
    toolslist[SdkMcpTool[Any]] | NoneNoneLista de funções de ferramenta criadas com decorador @tool

    Retorna

    Retorna um objeto McpSdkServerConfig que pode ser passado para ClaudeAgentOptions.mcp_servers.

    Exemplo

    from claude_agent_sdk import tool, create_sdk_mcp_server
    
    @tool("add", "Add two numbers", {"a": float, "b": float})
    async def add(args):
        return {
            "content": [{
                "type": "text",
                "text": f"Sum: {args['a'] + args['b']}"
            }]
        }
    
    @tool("multiply", "Multiply two numbers", {"a": float, "b": float})
    async def multiply(args):
        return {
            "content": [{
                "type": "text",
                "text": f"Product: {args['a'] * args['b']}"
            }]
        }
    
    calculator = create_sdk_mcp_server(
        name="calculator",
        version="2.0.0",
        tools=[add, multiply]  # Pass decorated functions
    )
    
    # Use with Claude
    options = ClaudeAgentOptions(
        mcp_servers={"calc": calculator},
        allowed_tools=["mcp__calc__add", "mcp__calc__multiply"]
    )

    Classes

    ClaudeSDKClient

    Mantém uma sessão de conversa em múltiplas trocas. Este é o equivalente Python de como a função query() do SDK TypeScript funciona internamente - ela cria um objeto cliente que pode continuar conversas.

    Recursos Principais

    • Continuidade de Sessão: Mantém contexto de conversa em múltiplas chamadas query()
    • Mesma Conversa: Claude se lembra de mensagens anteriores na sessão
    • Suporte a Interrupção: Pode parar Claude durante a execução
    • Ciclo de Vida Explícito: Você controla quando a sessão inicia e termina
    • Fluxo Orientado por Resposta: Pode reagir a respostas e enviar acompanhamentos
    • Ferramentas Personalizadas e Hooks: Suporta ferramentas personalizadas (criadas com decorador @tool) e hooks
    class ClaudeSDKClient:
        def __init__(self, options: ClaudeAgentOptions | None = None)
        async def connect(self, prompt: str | AsyncIterable[dict] | None = None) -> None
        async def query(self, prompt: str | AsyncIterable[dict], session_id: str = "default") -> None
        async def receive_messages(self) -> AsyncIterator[Message]
        async def receive_response(self) -> AsyncIterator[Message]
        async def interrupt(self) -> None
        async def rewind_files(self, user_message_uuid: str) -> None
        async def disconnect(self) -> None

    Métodos

    MétodoDescrição
    __init__(options)Inicializa o cliente com configuração opcional
    connect(prompt)Conecta ao Claude com um prompt inicial opcional ou fluxo de mensagem
    query(prompt, session_id)Envia uma nova solicitação em modo de streaming
    receive_messages()Recebe todas as mensagens de Claude como um iterador assíncrono
    receive_response()Recebe mensagens até e incluindo uma ResultMessage
    interrupt()Envia sinal de interrupção (funciona apenas em modo de streaming)
    rewind_files(user_message_uuid)Restaura arquivos para seu estado na mensagem de usuário especificada. Requer . Veja

    Suporte a Context Manager

    O cliente pode ser usado como um gerenciador de contexto assíncrono para gerenciamento automático de conexão:

    async with ClaudeSDKClient() as client:
        await client.query("Hello Claude")
        async for message in client.receive_response():
            print(message)

    Importante: Ao iterar sobre mensagens, evite usar break para sair cedo, pois isso pode causar problemas de limpeza do asyncio. Em vez disso, deixe a iteração ser concluída naturalmente ou use sinalizadores para rastrear quando você encontrou o que precisa.

    Exemplo - Continuando uma conversa

    import asyncio
    from claude_agent_sdk import ClaudeSDKClient, AssistantMessage, TextBlock, ResultMessage
    
    async def main():
        async with ClaudeSDKClient() as client:
            # First question
            await client.query("What's the capital of France?")
    
            # Process response
            async for message in client.receive_response():
                if isinstance(message, AssistantMessage):
                    for block in message.content:
                        if isinstance(block, TextBlock):
                            print(f"Claude: {block.text}")
    
            # Follow-up question - Claude remembers the previous context
            await client.query("What's the population of that city?")
    
            async for message in client.receive_response():
                if isinstance(message, AssistantMessage):
                    for block in message.content:
                        if isinstance(block, TextBlock):
                            print(f"Claude: {block.text}")
    
            # Another follow-up - still in the same conversation
            await client.query("What are some famous landmarks there?")
    
            async for message in client.receive_response():
                if isinstance(message, AssistantMessage):
                    for block in message.content:
                        if isinstance(block, TextBlock):
                            print(f"Claude: {block.text}")
    
    asyncio.run(main())

    Exemplo - Entrada em streaming com ClaudeSDKClient

    import asyncio
    from claude_agent_sdk import ClaudeSDKClient
    
    async def message_stream():
        """Generate messages dynamically."""
        yield {"type": "text", "text": "Analyze the following data:"}
        await asyncio.sleep(0.5)
        yield {"type": "text", "text": "Temperature: 25°C"}
        await asyncio.sleep(0.5)
        yield {"type": "text", "text": "Humidity: 60%"}
        await asyncio.sleep(0.5)
        yield {"type": "text", "text": "What patterns do you see?"}
    
    async def main():
        async with ClaudeSDKClient() as client:
            # Stream input to Claude
            await client.query(message_stream())
    
            # Process response
            async for message in client.receive_response():
                print(message)
    
            # Follow-up in same session
            await client.query("Should we be concerned about these readings?")
    
            async for message in client.receive_response():
                print(message)
    
    asyncio.run(main())

    Exemplo - Usando interrupções

    import asyncio
    from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions
    
    async def interruptible_task():
        options = ClaudeAgentOptions(
            allowed_tools=["Bash"],
            permission_mode="acceptEdits"
        )
    
        async with ClaudeSDKClient(options=options) as client:
            # Start a long-running task
            await client.query("Count from 1 to 100 slowly")
    
            # Let it run for a bit
            await asyncio.sleep(2)
    
            # Interrupt the task
            await client.interrupt()
            print("Task interrupted!")
    
            # Send a new command
            await client.query("Just say hello instead")
    
            async for message in client.receive_response():
                # Process the new response
                pass
    
    asyncio.run(interruptible_task())

    Exemplo - Controle de permissão avançado

    from claude_agent_sdk import (
        ClaudeSDKClient,
        ClaudeAgentOptions
    )
    
    async def custom_permission_handler(
        tool_name: str,
        input_data: dict,
        context: dict
    ):
        """Custom logic for tool permissions."""
    
        # Block writes to system directories
        if tool_name == "Write" and input_data.get("file_path", "").startswith("/system/"):
            return {
                "behavior": "deny",
                "message": "System directory write not allowed",
                "interrupt": True
            }
    
        # Redirect sensitive file operations
        if tool_name in ["Write", "Edit"] and "config" in input_data.get("file_path", ""):
            safe_path = f"./sandbox/{input_data['file_path']}"
            return {
                "behavior": "allow",
                "updatedInput": {**input_data, "file_path": safe_path}
            }
    
        # Allow everything else
        return {
            "behavior": "allow",
            "updatedInput": input_data
        }
    
    async def main():
        options = ClaudeAgentOptions(
            can_use_tool=custom_permission_handler,
            allowed_tools=["Read", "Write", "Edit"]
        )
    
        async with ClaudeSDKClient(options=options) as client:
            await client.query("Update the system config file")
    
            async for message in client.receive_response():
                # Will use sandbox path instead
                print(message)
    
    asyncio.run(main())

    Tipos

    SdkMcpTool

    Definição para uma ferramenta SDK MCP criada com o decorador @tool.

    @dataclass
    class SdkMcpTool(Generic[T]):
        name: str
        description: str
        input_schema: type[T] | dict[str, Any]
        handler: Callable[[T], Awaitable[dict[str, Any]]]
    PropriedadeTipoDescrição
    namestrIdentificador único para a ferramenta
    descriptionstrDescrição legível por humanos
    input_schematype[T] | dict[str, Any]Schema para validação de entrada
    handlerCallable[[T], Awaitable[dict[str, Any]]]Função assíncrona que manipula a execução da ferramenta

    ClaudeAgentOptions

    Dataclass de configuração para consultas Claude Code.

    @dataclass
    class ClaudeAgentOptions:
        allowed_tools: list[str] = field(default_factory=list)
        system_prompt: str | SystemPromptPreset | None = None
        mcp_servers: dict[str, McpServerConfig] | str | Path = field(default_factory=dict)
        permission_mode: PermissionMode | None = None
        continue_conversation: bool = False
        resume: str | None = None
        max_turns: int | None = None
        disallowed_tools: list[str] = field(default_factory=list)
        model: str | None = None
        output_format: OutputFormat | None = None
        permission_prompt_tool_name: str | None = None
        cwd: str | Path | None = None
        settings: str | None = None
        add_dirs: list[str | Path] = field(default_factory=list)
        env: dict[str, str] = field(default_factory=dict)
        extra_args: dict[str, str | None] = field(default_factory=dict)
        max_buffer_size: int | None = None
        debug_stderr: Any = sys.stderr  # Deprecated
        stderr: Callable[[str], None] | None = None
        can_use_tool: CanUseTool | None = None
        hooks: dict[HookEvent, list[HookMatcher]] | None = None
        user: str | None = None
        include_partial_messages: bool = False
        fork_session: bool = False
        agents: dict[str, AgentDefinition] | None = None
        setting_sources: list[SettingSource] | None = None
    PropriedadeTipoPadrãoDescrição
    allowed_toolslist[str][]Lista de nomes de ferramentas permitidas
    system_promptstr | SystemPromptPreset | NoneNoneConfiguração de prompt do sistema. Passe uma string para prompt personalizado, ou use {"type": "preset", "preset": "claude_code"} para o prompt do sistema Claude Code. Adicione "append" para estender o preset
    mcp_serversdict[str, McpServerConfig] | str | Path

    OutputFormat

    Configuração para validação de saída estruturada.

    class OutputFormat(TypedDict):
        type: Literal["json_schema"]
        schema: dict[str, Any]
    CampoObrigatórioDescrição
    typeSimDeve ser "json_schema" para validação JSON Schema
    schemaSimDefinição JSON Schema para validação de saída

    SystemPromptPreset

    Configuração para usar o prompt do sistema predefinido Claude Code com adições opcionais.

    class SystemPromptPreset(TypedDict):
        type: Literal["preset"]
        preset: Literal["claude_code"]
        append: NotRequired[str]
    CampoObrigatórioDescrição
    typeSimDeve ser "preset" para usar um prompt do sistema predefinido
    presetSimDeve ser "claude_code" para usar o prompt do sistema Claude Code
    appendNãoInstruções adicionais para anexar ao prompt do sistema predefinido

    SettingSource

    Controla quais fontes de configuração baseadas em sistema de arquivos o SDK carrega configurações.

    SettingSource = Literal["user", "project", "local"]
    ValorDescriçãoLocalização
    "user"Configurações globais do usuário~/.claude/settings.json
    "project"Configurações de projeto compartilhadas (controladas por versão).claude/settings.json
    "local"Configurações de projeto local (ignoradas por git).claude/settings.local.json

    Comportamento padrão

    Quando setting_sources é omitido ou None, o SDK não carrega nenhuma configuração do sistema de arquivos. Isso fornece isolamento para aplicações SDK.

    Por que usar setting_sources?

    Carregar todas as configurações do sistema de arquivos (comportamento legado):

    # Load all settings like SDK v0.0.x did
    from claude_agent_sdk import query, ClaudeAgentOptions
    
    async for message in query(
        prompt="Analyze this code",
        options=ClaudeAgentOptions(
            setting_sources=["user", "project", "local"]  # Load all settings
        )
    ):
        print(message)

    Carregar apenas fontes de configuração específicas:

    # Load only project settings, ignore user and local
    async for message in query(
        prompt="Run CI checks",
        options=ClaudeAgentOptions(
            setting_sources=["project"]  # Only .claude/settings.json
        )
    ):
        print(message)

    Ambientes de teste e CI:

    # Ensure consistent behavior in CI by excluding local settings
    async for message in query(
        prompt="Run tests",
        options=ClaudeAgentOptions(
            setting_sources=["project"],  # Only team-shared settings
            permission_mode="bypassPermissions"
        )
    ):
        print(message)

    Aplicações apenas SDK:

    # Define everything programmatically (default behavior)
    # No filesystem dependencies - setting_sources defaults to None
    async for message in query(
        prompt="Review this PR",
        options=ClaudeAgentOptions(
            # setting_sources=None is the default, no need to specify
            agents={ /* ... */ },
            mcp_servers={ /* ... */ },
            allowed_tools=["Read", "Grep", "Glob"]
        )
    ):
        print(message)

    Carregando instruções de projeto CLAUDE.md:

    # Load project settings to include CLAUDE.md files
    async for message in query(
        prompt="Add a new feature following project conventions",
        options=ClaudeAgentOptions(
            system_prompt={
                "type": "preset",
                "preset": "claude_code"  # Use Claude Code's system prompt
            },
            setting_sources=["project"],  # Required to load CLAUDE.md from project
            allowed_tools=["Read", "Write", "Edit"]
        )
    ):
        print(message)

    Precedência de configurações

    Quando múltiplas fontes são carregadas, as configurações são mescladas com esta precedência (maior para menor):

    1. Configurações locais (.claude/settings.local.json)
    2. Configurações de projeto (.claude/settings.json)
    3. Configurações de usuário (~/.claude/settings.json)

    Opções programáticas (como agents, allowed_tools) sempre substituem configurações do sistema de arquivos.

    AgentDefinition

    Configuração para um subagente definido programaticamente.

    @dataclass
    class AgentDefinition:
        description: str
        prompt: str
        tools: list[str] | None = None
        model: Literal["sonnet", "opus", "haiku", "inherit"] | None = None
    CampoObrigatórioDescrição
    descriptionSimDescrição em linguagem natural de quando usar este agente
    toolsNãoArray de nomes de ferramentas permitidas. Se omitido, herda todas as ferramentas
    promptSimO prompt do sistema do agente
    modelNãoSubstituição de modelo para este agente. Se omitido, usa o modelo principal

    PermissionMode

    Modos de permissão para controlar a execução de ferramentas.

    PermissionMode = Literal[
        "default",           # Standard permission behavior
        "acceptEdits",       # Auto-accept file edits
        "plan",              # Planning mode - no execution
        "bypassPermissions"  # Bypass all permission checks (use with caution)
    ]

    McpSdkServerConfig

    Configuração para servidores MCP SDK criados com create_sdk_mcp_server().

    class McpSdkServerConfig(TypedDict):
        type: Literal["sdk"]
        name: str
        instance: Any  # MCP Server instance

    McpServerConfig

    Tipo de união para configurações de servidor MCP.

    McpServerConfig = McpStdioServerConfig | McpSSEServerConfig | McpHttpServerConfig | McpSdkServerConfig

    McpStdioServerConfig

    class McpStdioServerConfig(TypedDict):
        type: NotRequired[Literal["stdio"]]  # Optional for backwards compatibility
        command: str
        args: NotRequired[list[str]]
        env: NotRequired[dict[str, str]]

    McpSSEServerConfig

    class McpSSEServerConfig(TypedDict):
        type: Literal["sse"]
        url: str
        headers: NotRequired[dict[str, str]]

    McpHttpServerConfig

    class McpHttpServerConfig(TypedDict):
        type: Literal["http"]
        url: str
        headers: NotRequired[dict[str, str]]

    SdkPluginConfig

    Configuração para carregar plugins no SDK.

    class SdkPluginConfig(TypedDict):
        type: Literal["local"]
        path: str
    CampoTipoDescrição
    typeLiteral["local"]Deve ser "local" (apenas plugins locais são suportados atualmente)
    pathstrCaminho absoluto ou relativo para o diretório do plugin

    Exemplo:

    plugins=[
        {"type": "local", "path": "./my-plugin"},
        {"type": "local", "path": "/absolute/path/to/plugin"}
    ]

    Para informações completas sobre criação e uso de plugins, veja Plugins.

    Tipos de Mensagem

    Message

    Tipo de união de todas as mensagens possíveis.

    Message = UserMessage | AssistantMessage | SystemMessage | ResultMessage

    UserMessage

    Mensagem de entrada do usuário.

    @dataclass
    class UserMessage:
        content: str | list[ContentBlock]

    AssistantMessage

    Mensagem de resposta do assistente com blocos de conteúdo.

    @dataclass
    class AssistantMessage:
        content: list[ContentBlock]
        model: str

    SystemMessage

    Mensagem do sistema com metadados.

    @dataclass
    class SystemMessage:
        subtype: str
        data: dict[str, Any]

    ResultMessage

    Mensagem de resultado final com informações de custo e uso.

    @dataclass
    class ResultMessage:
        subtype: str
        duration_ms: int
        duration_api_ms: int
        is_error: bool
        num_turns: int
        session_id: str
        total_cost_usd: float | None = None
        usage: dict[str, Any] | None = None
        result: str | None = None

    Tipos de Bloco de Conteúdo

    ContentBlock

    Tipo de união de todos os blocos de conteúdo.

    ContentBlock = TextBlock | ThinkingBlock | ToolUseBlock | ToolResultBlock

    TextBlock

    Bloco de conteúdo de texto.

    @dataclass
    class TextBlock:
        text: str

    ThinkingBlock

    Bloco de conteúdo de pensamento (para modelos com capacidade de pensamento).

    @dataclass
    class ThinkingBlock:
        thinking: str
        signature: str

    ToolUseBlock

    Bloco de solicitação de uso de ferramenta.

    @dataclass
    class ToolUseBlock:
        id: str
        name: str
        input: dict[str, Any]

    ToolResultBlock

    Bloco de resultado de execução de ferramenta.

    @dataclass
    class ToolResultBlock:
        tool_use_id: str
        content: str | list[dict[str, Any]] | None = None
        is_error: bool | None = None

    Tipos de Erro

    ClaudeSDKError

    Classe de exceção base para todos os erros do SDK.

    class ClaudeSDKError(Exception):
        """Erro base para Claude SDK."""

    CLINotFoundError

    Levantado quando Claude Code CLI não está instalado ou não foi encontrado.

    class CLINotFoundError(CLIConnectionError):
        def __init__(self, message: str = "Claude Code not found", cli_path: str | None = None):
            """
            Args:
                message: Mensagem de erro (padrão: "Claude Code not found")
                cli_path: Caminho opcional para a CLI que não foi encontrada
            """

    CLIConnectionError

    Levantado quando a conexão com Claude Code falha.

    class CLIConnectionError(ClaudeSDKError):
        """Falha ao conectar com Claude Code."""

    ProcessError

    Levantado quando o processo Claude Code falha.

    class ProcessError(ClaudeSDKError):
        def __init__(self, message: str, exit_code: int | None = None, stderr: str | None = None):
            self.exit_code = exit_code
            self.stderr = stderr

    CLIJSONDecodeError

    Levantado quando a análise JSON falha.

    class CLIJSONDecodeError(ClaudeSDKError):
        def __init__(self, line: str, original_error: Exception):
            """
            Args:
                line: A linha que falhou ao analisar
                original_error: A exceção original de decodificação JSON
            """
            self.line = line
            self.original_error = original_error

    Tipos de Hook

    Para um guia abrangente sobre como usar hooks com exemplos e padrões comuns, consulte o guia de Hooks.

    HookEvent

    Tipos de eventos de hook suportados. Observe que devido a limitações de configuração, o SDK Python não suporta hooks SessionStart, SessionEnd e Notification.

    HookEvent = Literal[
        "PreToolUse",      # Chamado antes da execução da ferramenta
        "PostToolUse",     # Chamado após a execução da ferramenta
        "UserPromptSubmit", # Chamado quando o usuário envia um prompt
        "Stop",            # Chamado ao parar a execução
        "SubagentStop",    # Chamado quando um subagente para
        "PreCompact"       # Chamado antes da compactação de mensagem
    ]

    HookCallback

    Definição de tipo para funções de callback de hook.

    HookCallback = Callable[
        [dict[str, Any], str | None, HookContext],
        Awaitable[dict[str, Any]]
    ]

    Parâmetros:

    • input_data: Dados de entrada específicos do hook (consulte guia de Hooks)
    • tool_use_id: Identificador opcional de uso de ferramenta (para hooks relacionados a ferramentas)
    • context: Contexto de hook com informações adicionais

    Retorna um dicionário que pode conter:

    • decision: "block" para bloquear a ação
    • systemMessage: Mensagem do sistema a adicionar à transcrição
    • hookSpecificOutput: Dados de saída específicos do hook

    HookContext

    Informações de contexto passadas para callbacks de hook.

    @dataclass
    class HookContext:
        signal: Any | None = None  # Futuro: suporte a sinal de aborto

    HookMatcher

    Configuração para corresponder hooks a eventos ou ferramentas específicas.

    @dataclass
    class HookMatcher:
        matcher: str | None = None        # Nome da ferramenta ou padrão a corresponder (por exemplo, "Bash", "Write|Edit")
        hooks: list[HookCallback] = field(default_factory=list)  # Lista de callbacks a executar
        timeout: float | None = None        # Tempo limite em segundos para todos os hooks neste matcher (padrão: 60)

    Exemplo de Uso de Hook

    Este exemplo registra dois hooks: um que bloqueia comandos bash perigosos como rm -rf /, e outro que registra todo o uso de ferramentas para auditoria. O hook de segurança só é executado em comandos Bash (via matcher), enquanto o hook de registro é executado em todas as ferramentas.

    from claude_agent_sdk import query, ClaudeAgentOptions, HookMatcher, HookContext
    from typing import Any
    
    async def validate_bash_command(
        input_data: dict[str, Any],
        tool_use_id: str | None,
        context: HookContext
    ) -> dict[str, Any]:
        """Validar e potencialmente bloquear comandos bash perigosos."""
        if input_data['tool_name'] == 'Bash':
            command = input_data['tool_input'].get('command', '')
            if 'rm -rf /' in command:
                return {
                    'hookSpecificOutput': {
                        'hookEventName': 'PreToolUse',
                        'permissionDecision': 'deny',
                        'permissionDecisionReason': 'Comando perigoso bloqueado'
                    }
                }
        return {}
    
    async def log_tool_use(
        input_data: dict[str, Any],
        tool_use_id: str | None,
        context: HookContext
    ) -> dict[str, Any]:
        """Registrar todo o uso de ferramentas para auditoria."""
        print(f"Ferramenta usada: {input_data.get('tool_name')}")
        return {}
    
    options = ClaudeAgentOptions(
        hooks={
            'PreToolUse': [
                HookMatcher(matcher='Bash', hooks=[validate_bash_command], timeout=120),  # 2 min para validação
                HookMatcher(hooks=[log_tool_use])  # Aplica a todas as ferramentas (tempo limite padrão de 60s)
            ],
            'PostToolUse': [
                HookMatcher(hooks=[log_tool_use])
            ]
        }
    )
    
    async for message in query(
        prompt="Analisar este repositório de código",
        options=options
    ):
        print(message)

    Tipos de Entrada/Saída de Ferramenta

    Documentação de esquemas de entrada/saída para todas as ferramentas Claude Code integradas. Embora o SDK Python não exporte esses como tipos, eles representam a estrutura de entradas e saídas de ferramentas em mensagens.

    Task

    Nome da ferramenta: Task

    Entrada:

    {
        "description": str,      # Uma descrição breve (3-5 palavras) da tarefa
        "prompt": str,           # A tarefa para o agente executar
        "subagent_type": str     # O tipo de agente especializado a usar
    }

    Saída:

    {
        "result": str,                    # Resultado final do subagente
        "usage": dict | None,             # Estatísticas de uso de token
        "total_cost_usd": float | None,  # Custo total em USD
        "duration_ms": int | None         # Duração da execução em milissegundos
    }

    Bash

    Nome da ferramenta: Bash

    Entrada:

    {
        "command": str,                  # O comando a executar
        "timeout": int | None,           # Tempo limite opcional em milissegundos (máximo 600000)
        "description": str | None,       # Descrição clara e concisa (5-10 palavras)
        "run_in_background": bool | None # Defina como true para executar em segundo plano
    }

    Saída:

    {
        "output": str,              # Saída combinada de stdout e stderr
        "exitCode": int,            # Código de saída do comando
        "killed": bool | None,      # Se o comando foi morto devido ao tempo limite
        "shellId": str | None       # ID do shell para processos em segundo plano
    }

    Edit

    Nome da ferramenta: Edit

    Entrada:

    {
        "file_path": str,           # O caminho absoluto do arquivo a modificar
        "old_string": str,          # O texto a substituir
        "new_string": str,          # O texto para substituir por
        "replace_all": bool | None  # Substituir todas as ocorrências (padrão False)
    }

    Saída:

    {
        "message": str,      # Mensagem de confirmação
        "replacements": int, # Número de substituições realizadas
        "file_path": str     # Caminho do arquivo que foi editado
    }

    Read

    Nome da ferramenta: Read

    Entrada:

    {
        "file_path": str,       # O caminho absoluto do arquivo a ler
        "offset": int | None,   # O número da linha para começar a ler
        "limit": int | None     # O número de linhas a ler
    }

    Saída (Arquivos de texto):

    {
        "content": str,         # Conteúdo do arquivo com números de linha
        "total_lines": int,     # Número total de linhas no arquivo
        "lines_returned": int   # Linhas realmente retornadas
    }

    Saída (Imagens):

    {
        "image": str,       # Dados de imagem codificados em Base64
        "mime_type": str,   # Tipo MIME da imagem
        "file_size": int    # Tamanho do arquivo em bytes
    }

    Write

    Nome da ferramenta: Write

    Entrada:

    {
        "file_path": str,  # O caminho absoluto do arquivo a escrever
        "content": str     # O conteúdo a escrever no arquivo
    }

    Saída:

    {
        "message": str,        # Mensagem de sucesso
        "bytes_written": int,  # Número de bytes escritos
        "file_path": str       # Caminho do arquivo que foi escrito
    }

    Glob

    Nome da ferramenta: Glob

    Entrada:

    {
        "pattern": str,       # O padrão glob para corresponder arquivos
        "path": str | None    # O diretório a pesquisar (padrão para cwd)
    }

    Saída:

    {
        "matches": list[str],  # Array de caminhos de arquivo correspondentes
        "count": int,          # Número de correspondências encontradas
        "search_path": str     # Diretório de pesquisa usado
    }

    Grep

    Nome da ferramenta: Grep

    Entrada:

    {
        "pattern": str,                    # O padrão de expressão regular
        "path": str | None,                # Arquivo ou diretório a pesquisar
        "glob": str | None,                # Padrão glob para filtrar arquivos
        "type": str | None,                # Tipo de arquivo a pesquisar
        "output_mode": str | None,         # "content", "files_with_matches", ou "count"
        "-i": bool | None,                 # Pesquisa insensível a maiúsculas/minúsculas
        "-n": bool | None,                 # Mostrar números de linha
        "-B": int | None,                  # Linhas a mostrar antes de cada correspondência
        "-A": int | None,                  # Linhas a mostrar após cada correspondência
        "-C": int | None,                  # Linhas a mostrar antes e depois
        "head_limit": int | None,          # Limitar saída às primeiras N linhas/entradas
        "multiline": bool | None           # Ativar modo multilinha
    }

    Saída (modo content):

    {
        "matches": [
            {
                "file": str,
                "line_number": int | None,
                "line": str,
                "before_context": list[str] | None,
                "after_context": list[str] | None
            }
        ],
        "total_matches": int
    }

    Saída (modo files_with_matches):

    {
        "files": list[str],  # Arquivos contendo correspondências
        "count": int         # Número de arquivos com correspondências
    }

    NotebookEdit

    Nome da ferramenta: NotebookEdit

    Entrada:

    {
        "notebook_path": str,                     # Caminho absoluto para o notebook Jupyter
        "cell_id": str | None,                    # O ID da célula a editar
        "new_source": str,                        # A nova fonte para a célula
        "cell_type": "code" | "markdown" | None,  # O tipo da célula
        "edit_mode": "replace" | "insert" | "delete" | None  # Tipo de operação de edição
    }

    Saída:

    {
        "message": str,                              # Mensagem de sucesso
        "edit_type": "replaced" | "inserted" | "deleted",  # Tipo de edição realizada
        "cell_id": str | None,                       # ID da célula que foi afetada
        "total_cells": int                           # Total de células no notebook após edição
    }

    WebFetch

    Nome da ferramenta: WebFetch

    Entrada:

    {
        "url": str,     # A URL para buscar conteúdo
        "prompt": str   # O prompt para executar no conteúdo buscado
    }

    Saída:

    {
        "response": str,           # Resposta do modelo de IA ao prompt
        "url": str,                # URL que foi buscada
        "final_url": str | None,   # URL final após redirecionamentos
        "status_code": int | None  # Código de status HTTP
    }

    WebSearch

    Nome da ferramenta: WebSearch

    Entrada:

    {
        "query": str,                        # A consulta de pesquisa a usar
        "allowed_domains": list[str] | None, # Incluir apenas resultados desses domínios
        "blocked_domains": list[str] | None  # Nunca incluir resultados desses domínios
    }

    Saída:

    {
        "results": [
            {
                "title": str,
                "url": str,
                "snippet": str,
                "metadata": dict | None
            }
        ],
        "total_results": int,
        "query": str
    }

    TodoWrite

    Nome da ferramenta: TodoWrite

    Entrada:

    {
        "todos": [
            {
                "content": str,                              # A descrição da tarefa
                "status": "pending" | "in_progress" | "completed",  # Status da tarefa
                "activeForm": str                            # Forma ativa da descrição
            }
        ]
    }

    Saída:

    {
        "message": str,  # Mensagem de sucesso
        "stats": {
            "total": int,
            "pending": int,
            "in_progress": int,
            "completed": int
        }
    }

    BashOutput

    Nome da ferramenta: BashOutput

    Entrada:

    {
        "bash_id": str,       # O ID do shell em segundo plano
        "filter": str | None  # Regex opcional para filtrar linhas de saída
    }

    Saída:

    {
        "output": str,                                      # Nova saída desde a última verificação
        "status": "running" | "completed" | "failed",       # Status atual do shell
        "exitCode": int | None                              # Código de saída quando concluído
    }

    KillBash

    Nome da ferramenta: KillBash

    Entrada:

    {
        "shell_id": str  # O ID do shell em segundo plano a matar
    }

    Saída:

    {
        "message": str,  # Mensagem de sucesso
        "shell_id": str  # ID do shell que foi morto
    }

    ExitPlanMode

    Nome da ferramenta: ExitPlanMode

    Entrada:

    {
        "plan": str  # O plano a executar pelo usuário para aprovação
    }

    Saída:

    {
        "message": str,          # Mensagem de confirmação
        "approved": bool | None  # Se o usuário aprovou o plano
    }

    ListMcpResources

    Nome da ferramenta: ListMcpResources

    Entrada:

    {
        "server": str | None  # Nome do servidor opcional para filtrar recursos por
    }

    Saída:

    {
        "resources": [
            {
                "uri": str,
                "name": str,
                "description": str | None,
                "mimeType": str | None,
                "server": str
            }
        ],
        "total": int
    }

    ReadMcpResource

    Nome da ferramenta: ReadMcpResource

    Entrada:

    {
        "server": str,  # O nome do servidor MCP
        "uri": str      # O URI do recurso a ler
    }

    Saída:

    {
        "contents": [
            {
                "uri": str,
                "mimeType": str | None,
                "text": str | None,
                "blob": str | None
            }
        ],
        "server": str
    }

    Recursos Avançados com ClaudeSDKClient

    Construindo uma Interface de Conversa Contínua

    from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock
    import asyncio
    
    class ConversationSession:
        """Mantém uma única sessão de conversa com Claude."""
    
        def __init__(self, options: ClaudeAgentOptions = None):
            self.client = ClaudeSDKClient(options)
            self.turn_count = 0
    
        async def start(self):
            await self.client.connect()
            print("Iniciando sessão de conversa. Claude lembrará do contexto.")
            print("Comandos: 'exit' para sair, 'interrupt' para parar tarefa atual, 'new' para nova sessão")
    
            while True:
                user_input = input(f"\n[Turno {self.turn_count + 1}] Você: ")
    
                if user_input.lower() == 'exit':
                    break
                elif user_input.lower() == 'interrupt':
                    await self.client.interrupt()
                    print("Tarefa interrompida!")
                    continue
                elif user_input.lower() == 'new':
                    # Desconectar e reconectar para uma sessão nova
                    await self.client.disconnect()
                    await self.client.connect()
                    self.turn_count = 0
                    print("Iniciada nova sessão de conversa (contexto anterior limpo)")
                    continue
    
                # Enviar mensagem - Claude lembra de todas as mensagens anteriores nesta sessão
                await self.client.query(user_input)
                self.turn_count += 1
    
                # Processar resposta
                print(f"[Turno {self.turn_count}] Claude: ", end="")
                async for message in self.client.receive_response():
                    if isinstance(message, AssistantMessage):
                        for block in message.content:
                            if isinstance(block, TextBlock):
                                print(block.text, end="")
                print()  # Nova linha após resposta
    
            await self.client.disconnect()
            print(f"Conversa encerrada após {self.turn_count} turnos.")
    
    async def main():
        options = ClaudeAgentOptions(
            allowed_tools=["Read", "Write", "Bash"],
            permission_mode="acceptEdits"
        )
        session = ConversationSession(options)
        await session.start()
    
    # Exemplo de conversa:
    # Turno 1 - Você: "Criar um arquivo chamado hello.py"
    # Turno 1 - Claude: "Vou criar um arquivo hello.py para você..."
    # Turno 2 - Você: "O que tem naquele arquivo?"
    # Turno 2 - Claude: "O arquivo hello.py que acabei de criar contém..." (lembra!)
    # Turno 3 - Você: "Adicione uma função main a ele"
    # Turno 3 - Claude: "Vou adicionar uma função main ao hello.py..." (sabe qual arquivo!)
    
    asyncio.run(main())

    Usando Hooks para Modificação de Comportamento

    from claude_agent_sdk import (
        ClaudeSDKClient,
        ClaudeAgentOptions,
        HookMatcher,
        HookContext
    )
    import asyncio
    from typing import Any
    
    async def pre_tool_logger(
        input_data: dict[str, Any],
        tool_use_id: str | None,
        context: HookContext
    ) -> dict[str, Any]:
        """Registrar todo o uso de ferramentas antes da execução."""
        tool_name = input_data.get('tool_name', 'unknown')
        print(f"[PRE-TOOL] Prestes a usar: {tool_name}")
    
        # Você pode modificar ou bloquear a execução da ferramenta aqui
        if tool_name == "Bash" and "rm -rf" in str(input_data.get('tool_input', {})):
            return {
                'hookSpecificOutput': {
                    'hookEventName': 'PreToolUse',
                    'permissionDecision': 'deny',
                    'permissionDecisionReason': 'Comando perigoso bloqueado'
                }
            }
        return {}
    
    async def post_tool_logger(
        input_data: dict[str, Any],
        tool_use_id: str | None,
        context: HookContext
    ) -> dict[str, Any]:
        """Registrar resultados após execução da ferramenta."""
        tool_name = input_data.get('tool_name', 'unknown')
        print(f"[POST-TOOL] Concluído: {tool_name}")
        return {}
    
    async def user_prompt_modifier(
        input_data: dict[str, Any],
        tool_use_id: str | None,
        context: HookContext
    ) -> dict[str, Any]:
        """Adicionar contexto aos prompts do usuário."""
        original_prompt = input_data.get('prompt', '')
    
        # Adicionar timestamp a todos os prompts
        from datetime import datetime
        timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
    
        return {
            'hookSpecificOutput': {
                'hookEventName': 'UserPromptSubmit',
                'updatedPrompt': f"[{timestamp}] {original_prompt}"
            }
        }
    
    async def main():
        options = ClaudeAgentOptions(
            hooks={
                'PreToolUse': [
                    HookMatcher(hooks=[pre_tool_logger]),
                    HookMatcher(matcher='Bash', hooks=[pre_tool_logger])
                ],
                'PostToolUse': [
                    HookMatcher(hooks=[post_tool_logger])
                ],
                'UserPromptSubmit': [
                    HookMatcher(hooks=[user_prompt_modifier])
                ]
            },
            allowed_tools=["Read", "Write", "Bash"]
        )
    
        async with ClaudeSDKClient(options=options) as client:
            await client.query("Listar arquivos no diretório atual")
    
            async for message in client.receive_response():
                # Hooks registrarão automaticamente o uso de ferramentas
                pass
    
    asyncio.run(main())

    Monitoramento de Progresso em Tempo Real

    from claude_agent_sdk import (
        ClaudeSDKClient,
        ClaudeAgentOptions,
        AssistantMessage,
        ToolUseBlock,
        ToolResultBlock,
        TextBlock
    )
    import asyncio
    
    async def monitor_progress():
        options = ClaudeAgentOptions(
            allowed_tools=["Write", "Bash"],
            permission_mode="acceptEdits"
        )
    
        async with ClaudeSDKClient(options=options) as client:
            await client.query(
                "Criar 5 arquivos Python com diferentes algoritmos de ordenação"
            )
    
            # Monitorar progresso em tempo real
            files_created = []
            async for message in client.receive_messages():
                if isinstance(message, AssistantMessage):
                    for block in message.content:
                        if isinstance(block, ToolUseBlock):
                            if block.name == "Write":
                                file_path = block.input.get("file_path", "")
                                print(f"🔨 Criando: {file_path}")
                        elif isinstance(block, ToolResultBlock):
                            print(f"✅ Execução de ferramenta concluída")
                        elif isinstance(block, TextBlock):
                            print(f"💭 Claude diz: {block.text[:100]}...")
    
                # Verificar se recebemos o resultado final
                if hasattr(message, 'subtype') and message.subtype in ['success', 'error']:
                    print(f"\n🎯 Tarefa concluída!")
                    break
    
    asyncio.run(monitor_progress())

    Exemplo de Uso

    Operações básicas de arquivo (usando query)

    from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, ToolUseBlock
    import asyncio
    
    async def create_project():
        options = ClaudeAgentOptions(
            allowed_tools=["Read", "Write", "Bash"],
            permission_mode='acceptEdits',
            cwd="/home/user/project"
        )
    
        async for message in query(
            prompt="Criar uma estrutura de projeto Python com setup.py",
            options=options
        ):
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, ToolUseBlock):
                        print(f"Usando ferramenta: {block.name}")
    
    asyncio.run(create_project())

    Tratamento de erros

    from claude_agent_sdk import (
        query,
        CLINotFoundError,
        ProcessError,
        CLIJSONDecodeError
    )
    
    try:
        async for message in query(prompt="Olá"):
            print(message)
    except CLINotFoundError:
        print("Por favor, instale Claude Code: npm install -g @anthropic-ai/claude-code")
    except ProcessError as e:
        print(f"Processo falhou com código de saída: {e.exit_code}")
    except CLIJSONDecodeError as e:
        print(f"Falha ao analisar resposta: {e}")

    Modo de streaming com cliente

    from claude_agent_sdk import ClaudeSDKClient
    import asyncio
    
    async def interactive_session():
        async with ClaudeSDKClient() as client:
            # Enviar mensagem inicial
            await client.query("Como está o tempo?")
    
            # Processar respostas
            async for msg in client.receive_response():
                print(msg)
    
            # Enviar acompanhamento
            await client.query("Me conte mais sobre isso")
    
            # Processar resposta de acompanhamento
            async for msg in client.receive_response():
                print(msg)
    
    asyncio.run(interactive_session())

    Usando ferramentas personalizadas com ClaudeSDKClient

    from claude_agent_sdk import (
        ClaudeSDKClient,
        ClaudeAgentOptions,
        tool,
        create_sdk_mcp_server,
        AssistantMessage,
        TextBlock
    )
    import asyncio
    from typing import Any
    
    # Definir ferramentas personalizadas com decorador @tool
    @tool("calculate", "Realizar cálculos matemáticos", {"expression": str})
    async def calculate(args: dict[str, Any]) -> dict[str, Any]:
        try:
            result = eval(args["expression"], {"__builtins__": {}})
            return {
                "content": [{
                    "type": "text",
                    "text": f"Resultado: {result}"
                }]
            }
        except Exception as e:
            return {
                "content": [{
                    "type": "text",
                    "text": f"Erro: {str(e)}"
                }],
                "is_error": True
            }
    
    @tool("get_time", "Obter hora atual", {})
    async def get_time(args: dict[str, Any]) -> dict[str, Any]:
        from datetime import datetime
        current_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
        return {
            "content": [{
                "type": "text",
                "text": f"Hora atual: {current_time}"
            }]
        }
    
    async def main():
        # Criar servidor MCP do SDK com ferramentas personalizadas
        my_server = create_sdk_mcp_server(
            name="utilities",
            version="1.0.0",
            tools=[calculate, get_time]
        )
    
        # Configurar opções com o servidor
        options = ClaudeAgentOptions(
            mcp_servers={"utils": my_server},
            allowed_tools=[
                "mcp__utils__calculate",
                "mcp__utils__get_time"
            ]
        )
    
        # Usar ClaudeSDKClient para uso interativo de ferramentas
        async with ClaudeSDKClient(options=options) as client:
            await client.query("Quanto é 123 * 456?")
    
            # Processar resposta de cálculo
            async for message in client.receive_response():
                if isinstance(message, AssistantMessage):
                    for block in message.content:
                        if isinstance(block, TextBlock):
                            print(f"Cálculo: {block.text}")
    
            # Acompanhamento com consulta de hora
            await client.query("Que horas são agora?")
    
            async for message in client.receive_response():
                if isinstance(message, AssistantMessage):
                    for block in message.content:
                        if isinstance(block, TextBlock):
                            print(f"Hora: {block.text}")
    
    asyncio.run(main())

    Configuração de Sandbox

    SandboxSettings

    Configuração para comportamento de sandbox. Use isso para ativar sandboxing de comando e configurar restrições de rede programaticamente.

    class SandboxSettings(TypedDict, total=False):
        enabled: bool
        autoAllowBashIfSandboxed: bool
        excludedCommands: list[str]
        allowUnsandboxedCommands: bool
        network: SandboxNetworkConfig
        ignoreViolations: SandboxIgnoreViolations
        enableWeakerNestedSandbox: bool
    PropriedadeTipoPadrãoDescrição
    enabledboolFalseAtivar modo sandbox para execução de comando
    autoAllowBashIfSandboxedboolFalseAprovar automaticamente comandos bash quando sandbox está ativado
    excludedCommandslist[str][]Comandos que sempre contornam restrições de sandbox (por exemplo, ["docker"]). Esses são executados sem sandbox automaticamente sem envolvimento do modelo

    Restrições de acesso a sistema de arquivos e rede NÃO são configuradas via configurações de sandbox. Em vez disso, elas são derivadas de regras de permissão:

    • Restrições de leitura do sistema de arquivos: Regras de negação de leitura
    • Restrições de escrita do sistema de arquivos: Regras de permissão/negação de edição
    • Restrições de rede: Regras de permissão/negação de WebFetch

    Use configurações de sandbox para sandboxing de execução de comando, e regras de permissão para controle de acesso a sistema de arquivos e rede.

    Exemplo de uso

    from claude_agent_sdk import query, ClaudeAgentOptions, SandboxSettings
    
    sandbox_settings: SandboxSettings = {
        "enabled": True,
        "autoAllowBashIfSandboxed": True,
        "excludedCommands": ["docker"],
        "network": {
            "allowLocalBinding": True,
            "allowUnixSockets": ["/var/run/docker.sock"]
        }
    }
    
    async for message in query(
        prompt="Construir e testar meu projeto",
        options=ClaudeAgentOptions(sandbox=sandbox_settings)
    ):
        print(message)

    SandboxNetworkConfig

    Configuração específica de rede para modo sandbox.

    class SandboxNetworkConfig(TypedDict, total=False):
        allowLocalBinding: bool
        allowUnixSockets: list[str]
        allowAllUnixSockets: bool
        httpProxyPort: int
        socksProxyPort: int
    PropriedadeTipoPadrãoDescrição
    allowLocalBindingboolFalsePermitir que processos se vinculem a portas locais (por exemplo, para servidores de desenvolvimento)
    allowUnixSocketslist[str][]Caminhos de socket Unix que processos podem acessar (por exemplo, socket Docker)
    allowAllUnixSocketsboolFalsePermitir acesso a todos os sockets Unix

    SandboxIgnoreViolations

    Configuração para ignorar violações de sandbox específicas.

    class SandboxIgnoreViolations(TypedDict, total=False):
        file: list[str]
        network: list[str]
    PropriedadeTipoPadrãoDescrição
    filelist[str][]Padrões de caminho de arquivo para ignorar violações
    networklist[str][]Padrões de rede para ignorar violações

    Fallback de Permissões para Comandos Sem Sandbox

    Quando allowUnsandboxedCommands está ativado, o modelo pode solicitar executar comandos fora do sandbox definindo dangerouslyDisableSandbox: True na entrada da ferramenta. Essas solicitações voltam para o sistema de permissões existente, significando que seu manipulador can_use_tool será invocado, permitindo que você implemente lógica de autorização personalizada.

    excludedCommands vs allowUnsandboxedCommands:

    • excludedCommands: Uma lista estática de comandos que sempre contornam o sandbox automaticamente (por exemplo, ["docker"]). O modelo não tem controle sobre isso.
    • allowUnsandboxedCommands: Permite que o modelo decida em tempo de execução se deve solicitar execução sem sandbox definindo dangerouslyDisableSandbox: True na entrada da ferramenta.
    from claude_agent_sdk import query, ClaudeAgentOptions
    
    async def can_use_tool(tool: str, input: dict) -> bool:
        # Verificar se o modelo está solicitando contornar o sandbox
        if tool == "Bash" and input.get("dangerouslyDisableSandbox"):
            # O modelo quer executar este comando fora do sandbox
            print(f"Comando sem sandbox solicitado: {input.get('command')}")
    
            # Retornar True para permitir, False para negar
            return is_command_authorized(input.get("command"))
        return True
    
    async def main():
        async for message in query(
            prompt="Implantar minha aplicação",
            options=ClaudeAgentOptions(
                sandbox={
                    "enabled": True,
                    "allowUnsandboxedCommands": True  # Modelo pode solicitar execução sem sandbox
                },
                permission_mode="default",
                can_use_tool=can_use_tool
            )
        ):
            print(message)

    Este padrão permite que você:

    • Auditar solicitações do modelo: Registrar quando o modelo solicita execução sem sandbox
    • Implementar listas de permissão: Permitir apenas comandos específicos para executar sem sandbox
    • Adicionar fluxos de trabalho de aprovação: Exigir autorização explícita para operações privilegiadas

    Comandos em execução com dangerouslyDisableSandbox: True têm acesso total ao sistema. Certifique-se de que seu manipulador can_use_tool valida essas solicitações cuidadosamente.

    Veja também

    • Guia do SDK Python - Tutorial e exemplos
    • Visão geral do SDK - Conceitos gerais do SDK
    • Referência do SDK TypeScript - Documentação do SDK TypeScript
    • Referência da CLI - Interface de linha de comando
    • Fluxos de trabalho comuns - Guias passo a passo
    enable_file_checkpointing=True
    File checkpointing
    disconnect()Desconecta de Claude
    {}
    Configurações de servidor MCP ou caminho para arquivo de configuração
    permission_modePermissionMode | NoneNoneModo de permissão para uso de ferramentas
    continue_conversationboolFalseContinuar a conversa mais recente
    resumestr | NoneNoneID de sessão para retomar
    max_turnsint | NoneNoneMáximo de turnos de conversa
    disallowed_toolslist[str][]Lista de nomes de ferramentas não permitidas
    enable_file_checkpointingboolFalseAtivar rastreamento de alterações de arquivo para retrocesso. Veja File checkpointing
    modelstr | NoneNoneModelo Claude a usar
    output_formatOutputFormat | NoneNoneDefinir formato de saída para resultados de agente. Veja Structured outputs para detalhes
    permission_prompt_tool_namestr | NoneNoneNome da ferramenta MCP para prompts de permissão
    cwdstr | Path | NoneNoneDiretório de trabalho atual
    settingsstr | NoneNoneCaminho para arquivo de configurações
    add_dirslist[str | Path][]Diretórios adicionais que Claude pode acessar
    envdict[str, str]{}Variáveis de ambiente
    extra_argsdict[str, str | None]{}Argumentos CLI adicionais para passar diretamente para a CLI
    max_buffer_sizeint | NoneNoneMáximo de bytes ao fazer buffer de stdout da CLI
    debug_stderrAnysys.stderrDescontinuado - Objeto semelhante a arquivo para saída de depuração. Use callback stderr em vez disso
    stderrCallable[[str], None] | NoneNoneFunção de callback para saída stderr da CLI
    can_use_toolCanUseTool | NoneNoneFunção de callback de permissão de ferramenta
    hooksdict[HookEvent, list[HookMatcher]] | NoneNoneConfigurações de hook para interceptar eventos
    userstr | NoneNoneIdentificador de usuário
    include_partial_messagesboolFalseIncluir eventos de streaming de mensagem parcial
    fork_sessionboolFalseAo retomar com resume, fazer fork para um novo ID de sessão em vez de continuar a sessão original
    agentsdict[str, AgentDefinition] | NoneNoneSubagentes definidos programaticamente
    pluginslist[SdkPluginConfig][]Carregar plugins personalizados de caminhos locais. Veja Plugins para detalhes
    sandboxSandboxSettings | NoneNoneConfigurar comportamento de sandbox programaticamente. Veja Sandbox settings para detalhes
    setting_sourceslist[SettingSource] | NoneNone (sem configurações)Controlar quais configurações do sistema de arquivos carregar. Quando omitido, nenhuma configuração é carregada. Nota: Deve incluir "project" para carregar arquivos CLAUDE.md
    allowUnsandboxedCommandsboolFalsePermitir que o modelo solicite executar comandos fora do sandbox. Quando True, o modelo pode definir dangerouslyDisableSandbox na entrada da ferramenta, que volta para o sistema de permissões
    networkSandboxNetworkConfigNoneConfiguração de sandbox específica de rede
    ignoreViolationsSandboxIgnoreViolationsNoneConfigurar quais violações de sandbox ignorar
    enableWeakerNestedSandboxboolFalseAtivar um sandbox aninhado mais fraco para compatibilidade
    httpProxyPort
    int
    None
    Porta proxy HTTP para solicitações de rede
    socksProxyPortintNonePorta proxy SOCKS para solicitações de rede