smallforce calls tools
Manage the custom tools receptionists can use on calls
This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.13. Run smallforce calls tools --help locally to view the same reference for your installed version.
Subcommands
smallforce calls tools list: List tools and keyssmallforce calls tools get: Get a tool and its definitionsmallforce calls tools create: Create a tool from JSON: { displayName, description, definition: { inputs, request, response, waitMode, … }, keyId? }smallforce calls tools update: Update a tool from JSON (only the fields given change)smallforce calls tools archive: Archive a tool (calls already running keep it)smallforce calls tools restore: Restore an archived toolsmallforce calls tools test: Send a real request with the given inputs and show what the AI would hearsmallforce calls tools import-curl: Turn a curl command into a draft tool (nothing is saved)smallforce calls tools runs: Show a tool’s recent runssmallforce calls tools on: Turn a tool on for a receptionist (from its next call)smallforce calls tools off: Turn a tool off for a receptionist (from its next call)smallforce calls tools for: List every tool with whether it’s on for a receptionistsmallforce calls tools signing-secret: Show or rotate the secret every tool request is signed with
Complete command help
Usage: smallforce calls tools [options] [command]
Manage the custom tools receptionists can use on calls
Options:
--api-key <key> SmallForce API key, or set SMALLFORCE_API_KEY
--backend-url <url> SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
--json Print stable machine-readable JSON
--text Print human-readable text
--format <format> Output format: text or json
-h, --help display help for command
Commands:
list [options] List tools and keys
get [options] <toolId> Get a tool and its definition
create [options] Create a tool from JSON: { displayName, description,
definition: { inputs, request, response, waitMode, ... },
keyId? }
update [options] <toolId> Update a tool from JSON (only the fields given change)
archive [options] <toolId> Archive a tool (calls already running keep it)
restore [options] <toolId> Restore an archived tool
test [options] <toolId> Send a real request with the given inputs and show what the
AI would hear
import-curl [options] Turn a curl command into a draft tool (nothing is saved)
runs [options] <toolId> Show a tool's recent runs
on [options] <assistantId> <toolId> Turn a tool on for a receptionist (from its next call)
off [options] <assistantId> <toolId> Turn a tool off for a receptionist (from its next call)
for [options] <assistantId> List every tool with whether it's on for a receptionist
signing-secret [options] Show or rotate the secret every tool request is signed with
help [command] display help for command
Related reference
smallforce calls: Parent command and related operations.- CLI installation and authentication: Install the CLI and configure an API key.
- CLI JSON output: Use stable machine-readable output in scripts and agents.