ShellTool

Bases: Tool

Shell/bash execution tool.

Provider-specific mapping:

• Anthropic — maps to bash_20250124. Claude calls the tool with a command or restart input; the application must execute it and return the result (client-side tool). environment is ignored for Anthropic.

• OpenAI Responses API — maps to shell (gpt-5.4). Use environment to control where commands execute: ContainerAutoEnvironment, ContainerReferenceEnvironment, or LocalEnvironment. Omit environment for OpenAI's default behaviour.

See: - https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool - https://developers.openai.com/api/docs/guides/tools-shell

86
87
88
89
90
91
92
93

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

schemas(context)

95
96
97

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=())

 99
100
101
102
103
104
105
106

def register(
    self,
    stack: "ExitStack",
    context: "Context",
    *,
    middleware: Iterable["BaseMiddleware"] = (),
) -> None:
    pass