ShellToolboxTool interface
A shell tool stored in a toolbox. This model is additive to toolbox configuration and does not modify the OpenAI tool contract or existing toolbox tool definitions.
- Extends
Properties
| allowed_callers | The invocation modes permitted to call this shell tool: direct calls, programmatic calls, or both. |
| environment | The environment in which shell commands are executed. Specify an automatically provisioned container or an existing container. |
| type | The type of the tool. Always |
Inherited Properties
| description | Optional user-defined description for this tool or configuration. |
| name | Optional user-defined name for this tool or configuration. |
| tool_configs | Per-tool configuration map. Keys are tool names or |
Property Details
allowed_callers
The invocation modes permitted to call this shell tool: direct calls, programmatic calls, or both.
allowed_callers?: CallableToolAllowedCaller[]Property Value
environment
The environment in which shell commands are executed. Specify an automatically provisioned container or an existing container.
environment: ToolboxShellEnvironmentUnionProperty Value
type
The type of the tool. Always shell.
type: "shell"Property Value
"shell"
Inherited Property Details
description
Optional user-defined description for this tool or configuration.
description?: stringProperty Value
string
Inherited From ToolboxTool.description
name
Optional user-defined name for this tool or configuration.
name?: stringProperty Value
string
Inherited From ToolboxTool.name
tool_configs
Per-tool configuration map. Keys are tool names or * (catch-all default).
Resolution order: exact tool name match takes priority over *.
Unknown tool names are silently ignored at runtime.
tool_configs?: Record<string, ToolConfig>Property Value
Record<string, ToolConfig>
Inherited From ToolboxTool.tool_configs