ShellTool

Bases: Tool

Shell execution tool — provider-executed server-side.

Provider support:

• OpenAI Responses API — maps to shell. Use environment to control where commands execute: ContainerAutoEnvironment, ContainerReferenceEnvironment.

• Anthropic — NOT supported. Claude's bash tool is a client-side tool (the application must execute the command and return the result). Using ShellTool with AnthropicConfig raises :class:~autogen.beta.exceptions.UnsupportedToolError. Use :class:~autogen.beta.tools.LocalShellTool instead, which runs commands via subprocess and works with any provider.

See: - https://developers.openai.com/api/docs/guides/tools-shell

90
91
92
93
94
95
96
97
98
99

def __init__(
    self,
    *,
    environment: ShellEnvironment | Variable | None = None,
    version: Literal["bash_20250124"] = "bash_20250124",
) -> None:
    self._params: dict[str, object] = {"version": version}
    if environment is not None:
        self._params["environment"] = environment
    self.name = SHELL_TOOL_NAME

name = SHELL_TOOL_NAME

schemas(context)

101
102
103

async def schemas(self, context: "Context") -> list[ShellToolSchema]:
    resolved = {k: resolve_variable(v, context, param_name=k) for k, v in self._params.items()}
    return [ShellToolSchema(**resolved)]

register(stack, context, *, middleware=())

105
106
107
108
109
110
111
112
113
114
115
116
117

def register(
    self,
    stack: "ExitStack | AsyncExitStack",
    context: "Context",
    *,
    middleware: Iterable["BaseMiddleware"] = (),
) -> None:
    async def execute(event: "ToolCallEvent", context: "Context") -> None:
        pass

    stack.enter_context(
        context.stream.where(BuiltinToolCallEvent.name == SHELL_TOOL_NAME).sub_scope(execute),
    )

set_provider(provider)

20
21

def set_provider(self, provider: Provider) -> None:
    pass