Scale Intelligence■ Docs
Docs / The model / Tool

Tool.

A capability from the tool register, with its inputs and outputs as owning types; generated, never written by hand

Figure 1Toolspecified
TOOLrow at platform scopesi.<family>.<verb>nametextfamilyenum:session|ask|read|view|act|work|harness|f…the specification's interface rowfrom_rowtexta type of this registerinput_typetextthe body of the cardoutput_typetextrungenum:user|tenant|brand|strategygrantenum:read|ask|act|work|files|adminwhereenum:platform|app|eitherreturns a tasklongbooldirect is in the first list a model sees; deferred is reached by paging one family at a time; workbench only from code in the workbench (WA-134)exposureenum:direct|deferred|workbenchpermissionPermissionoff for a tenant is absent from the liststateReadinessPERMISSIONthrough permissionREADINESSthrough stateand 2 more fields on this page
Tool is a row at platform scope. The drawing shows its fields and the objects that they point at.
kind
row
scope
platform
key
its name
store
postgres
family
harness

Fields#

fieldtyperequirednote
nametextyessi..
familyone of session | ask | read | view | act | work | harness | filesyes
from_rowtextyesthe specification’s interface row
input_typetextyesa type of this register
output_typetextyesthe body of the card
rungone of user | tenant | brand | strategyyes
grantone of read | ask | act | work | files | adminyes
whereone of platform | app | eitheryes
longboolyesreturns a task
exposureone of direct | deferred | workbenchyesdirect is in the first list a model sees; deferred is reached by paging one family at a time; workbench only from code in the workbench
permissionPermissionyes
stateReadinessyesoff for a tenant is absent from the list
takestextyesthe plain sentence of what the tool takes, as the tool register prints it
givestextyesthe plain sentence of what the tool gives

Routes that use it#

No route takes or returns Tool directly. The record holds it, and the objects that point at it reach it.