Class ToolOrigin

src/agents/tool.py:279–322

Serializable metadata describing where a function-tool-backed item came from.

@dataclass(frozen=True)
class ToolOrigin:
    """Serializable metadata describing where a function-tool-backed item came from."""

    type: ToolOriginType
    mcp_server_name: str | None = None
    agent_name: str | None = None
    agent_tool_name: str | None = None

    def to_json_dict(self) -> dict[str, str]:
        """Convert the metadata to a JSON-compatible dict."""
        result: dict[str, str] = {"type": self.type.value}
        if self.mcp_server_name is not None:
            result["mcp_server_name"] = self.mcp_server_name
        if self.agent_name is not None:
            result["agent_name"] = self.agent_name
        if self.agent_tool_name is not None:
            result["agent_tool_name"] = self.agent_tool_name
        return result

    @classmethod
    def from_json_dict(cls, data: Any) -> ToolOrigin | None:
        """Deserialize tool origin metadata from JSON-compatible data."""
        if not isinstance(data, Mapping):
            return None

        raw_type = data.get("type")
        if not isinstance(raw_type, str):
            return None

        try:
            origin_type = ToolOriginType(raw_type)
        except ValueError:
            return None

        def _optional_string(key: str) -> str | None:
            value = data.get(key)
            return value if isinstance(value, str) else None

        return cls(
            type=origin_type,
            mcp_server_name=_optional_string("mcp_server_name"),
            agent_name=_optional_string("agent_name"),
            agent_tool_name=_optional_string("agent_tool_name"),
        )


ComputerLike = Computer | AsyncComputer