ToolDefinition

A tool as you write it: its spec (minus id, which is its key in tools) plus the code behind it.

Type Parameters

Type Parameter	Default type
F extends readonly ToolField[]	readonly ToolField[]
A extends readonly ToolAction[]	readonly ToolAction[]

Properties

actions?

optional actions?: A

---

category?

optional category?: ToolCategory

---

clipboardKinds?

optional clipboardKinds?: readonly ClipboardKind[]

---

dropActions?

optional dropActions?: readonly ToolDropAction[]

---

fields?

optional fields?: F

---

icon

icon: string

SF Symbol name.

---

live?

optional live?: boolean

---

remembersInputs?

optional remembersInputs?: boolean

---

summary?

optional summary?: string

One line: what it does for you.

---

title

title: string

One or two short words: it sits under an icon in the tray.

Methods

drop()?

optional drop(action, files, ctx): Promise<ToolDropResult>

Runs one of dropActions on dropped files (absolute paths). Required when dropActions is set.

Parameters

Parameter	Type
action	string
files	string[]
ctx	ToolContext

Returns

Promise<ToolDropResult>

---

run()

run(action, values, ctx): Promise<ToolBlock[]>

Runs one of actions. Return the output blocks; throw an Error whose message says what went wrong and what to do (“Can’t reach npm. Check your connection.”) and Blipbar shows it as a failed status.

Parameters

Parameter	Type
action	A[number]["id"]
values	ToolValues<F>
ctx	ToolContext

Returns

Promise<ToolBlock[]>