Tool Commands

View as Markdown

Define tools, bundle toolsets, and inspect tool calls.

Output formatting flags (--json, --jq, and --template) are documented once in Output Formatting and are omitted from the tables below.

bctrl tools list

List tools

$bctrl tools list [flags]
FlagDescription
--space <id>Filter by space id
-L, --limit <number>Maximum number of results to return
--cursor <cursor>Pagination cursor

bctrl tools get

Get a tool

$bctrl tools get <id>

bctrl tools create

Create a tool

$bctrl tools create

bctrl tools patch

Update a tool

$bctrl tools patch <id>

bctrl tools call

Call a tool and wait for its result

$bctrl tools call <toolRef> [flags]
FlagDescription
--runtime <id>Runtime whose active Run should execute the Tool

bctrl tools start

Start an asynchronous tool call

$bctrl tools start <toolRef> [flags]
FlagDescription
--runtime <id>Runtime whose active Run should execute the Tool

bctrl tools delete

Delete a tool

$bctrl tools delete <id> [flags]
FlagDescription
-y, --yesConfirm deletion

bctrl toolsets list

List toolsets

$bctrl toolsets list [flags]
FlagDescription
--space <id>Filter by space id

bctrl toolsets get

View a toolset

$bctrl toolsets get <id>

bctrl toolsets create

Create a toolset

$bctrl toolsets create

bctrl toolsets patch

Edit a toolset

$bctrl toolsets patch <id>

bctrl toolsets delete

Delete a toolset

$bctrl toolsets delete <id> [flags]
FlagDescription
-y, --yesConfirm deletion

bctrl tool-calls list

List tool calls

$bctrl tool-calls list [flags]
FlagDescription
--space <id>Space id
--tool <id>Filter by tool id
--run <id>Filter by run id
--status <status>Filter by status
--caller-type <type>Filter by caller type

bctrl tool-calls cancel

Cancel a tool call

$bctrl tool-calls cancel <toolCallId>

bctrl tool-calls respond

Respond to a tool input request

$bctrl tool-calls respond <toolCallId>

bctrl tool-calls result

Wait for and return a tool call result

$bctrl tool-calls result <toolCallId>

bctrl tool-calls get

View a tool call

$bctrl tool-calls get <id>