Custom Tools

sim custom-tools is also spelled sim custom-tool.

Every command below also accepts the global options.

Create custom tool

sim custom-tools create [options]

Options

OptionRequiredDescription
--title <value>YesDisplay title, unique within the workspace.
--schema <json|@file>YesOpenAI function schema: {"type":"function","function":{"name":"...","parameters":{"type":"object","properties":{}}}} (JSON, or @path / @- to read a file or stdin).
--code <value>YesTool implementation executed in the sandboxed function runtime.

Delete custom tool

sim custom-tools delete <id> [options]

Arguments

ArgumentRequiredDescription
idYesUnique custom tool identifier.

Options

OptionRequiredDescription
-y, --yesNoSkip the confirmation.

Get custom tool

sim custom-tools get <id>

Arguments

ArgumentRequiredDescription
idYesUnique custom tool identifier.

List custom tools

sim custom-tools list [options]

Options

OptionRequiredDescription
--search <value>NoCase-insensitive substring match against the tool title.
--sort-by <value>NoField used to sort the result. Accepted values: title, createdAt, updatedAt.
--sort-order <value>NoSort direction. Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 100.

Update custom tool

sim custom-tools update <id> [options]

Arguments

ArgumentRequiredDescription
idYesUnique custom tool identifier.

Options

OptionRequiredDescription
--title <value>NoNew display title for the tool.
--schema <json|@file>NoOpenAI function schema: {"type":"function","function":{"name":"...","parameters":{"type":"object","properties":{}}}} (JSON, or @path / @- to read a file or stdin).
--code <value>NoReplacement tool implementation.

On this page