Class ComputerTool

src/agents/tool.py:715–743

A local computer harness exposed through the Responses API computer tool.

@dataclass(eq=False)
class ComputerTool(Generic[ComputerT]):
    """A local computer harness exposed through the Responses API computer tool."""

    computer: ComputerT | ComputerCreate[ComputerT] | ComputerProvider[ComputerT]
    """The computer implementation, or a factory that produces a computer per run."""

    on_safety_check: Callable[[ComputerToolSafetyCheckData], MaybeAwaitable[bool]] | None = None
    """Optional callback to acknowledge computer tool safety checks."""

    custom_data_extractor: ComputerToolCustomDataExtractor | None = field(
        default=None,
        kw_only=True,
    )
    """Optional callback that attaches SDK-only custom data to the tool output item."""

    def __post_init__(self) -> None:
        _store_computer_initializer(self)

    @property
    def name(self):
        # Keep the released preview-era runtime name for hooks and persisted
        # RunState compatibility. The Responses serializer selects the actual
        # wire tool type separately.
        return "computer_use_preview"

    @property
    def trace_name(self):
        # Tracing should display the GA tool alias even while runtime names preserve compatibility.
        return "computer"


@dataclass