ApiCoreInterfaces
Interface: NodeAction
Defined in: packages/core/src/node/actions.ts:56
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
description | readonly | string | One or more sentences, for a person or a model | packages/core/src/node/actions.ts:62 |
destructive? | readonly | boolean | Removes or overwrites something, or brings in someone else's space. A front end should ask a person before an agent runs it: an agent reads records other people wrote, and one of them may be telling it what to do. | packages/core/src/node/actions.ts:78 |
input | readonly | ActionSchema | What it takes, as a JSON Schema object | packages/core/src/node/actions.ts:64 |
name | readonly | string | [a-z_]+, so it is a valid tool name everywhere | packages/core/src/node/actions.ts:58 |
peerContent? | readonly | boolean | Returns what other people wrote — record bodies, names, collection descriptions. Data for an agent to read, never instructions to follow. | packages/core/src/node/actions.ts:83 |
readOnly | readonly | boolean | Reads only. Agents may run these without asking; everything else changes data. Default false. | packages/core/src/node/actions.ts:66 |
run | readonly | (node, input) => Promise<unknown> | Runs it. Input and output are plain JSON: never a key, a handle or a function. | packages/core/src/node/actions.ts:85 |
sensitive? | readonly | boolean | Returns something that grants access — an invite to a private space carries its key. A front end should confirm with a person before handing the result to anyone. | packages/core/src/node/actions.ts:72 |
title | readonly | string | A few words for people: what a client shows when it asks before running it | packages/core/src/node/actions.ts:60 |