Skip to main content

Interface: DataAccessAbilityConfig

Defined in: packages/sdk/src/types/ability-types.ts:164

Config for data_access ability

Properties

autoCreate?

optional autoCreate: boolean

Defined in: packages/sdk/src/types/ability-types.ts:194

When true, auto-create a record for the assignment if one doesn't exist (default: false)


canCreate?

optional canCreate: boolean

Defined in: packages/sdk/src/types/ability-types.ts:168

Whether the agent can create new records (default: false)


canDelete?

optional canDelete: boolean

Defined in: packages/sdk/src/types/ability-types.ts:180

Whether the agent can delete records (default: false)


canEdit?

optional canEdit: boolean

Defined in: packages/sdk/src/types/ability-types.ts:172

Whether the agent can update existing records (default: false)


canGeolocate?

optional canGeolocate: boolean

Defined in: packages/sdk/src/types/ability-types.ts:178

Whether the agent can search records by geographic location (default: false)


canListAll?

optional canListAll: boolean

Defined in: packages/sdk/src/types/ability-types.ts:176

Whether the agent can list all members' records (default: false)


canRead?

optional canRead: boolean

Defined in: packages/sdk/src/types/ability-types.ts:170

Whether the agent can list and search records (default: true)


canVerify?

optional canVerify: boolean

Defined in: packages/sdk/src/types/ability-types.ts:174

Whether the agent can verify record data (default: false)


createFields?

optional createFields: string[]

Defined in: packages/sdk/src/types/ability-types.ts:192

Field slugs the agent can set when creating records. If empty/undefined, all fields are available.


dataTypeUuid

dataTypeUuid: string

Defined in: packages/sdk/src/types/ability-types.ts:166

UUID of the data type to provide tools for


readFields?

optional readFields: string[]

Defined in: packages/sdk/src/types/ability-types.ts:182

Field slugs the agent can read. If empty/undefined, all fields are readable.


readLimit?

optional readLimit: number

Defined in: packages/sdk/src/types/ability-types.ts:184

Maximum records returned by list tools. If empty/undefined, the default page size is used.


readSortDirection?

optional readSortDirection: "asc" | "desc"

Defined in: packages/sdk/src/types/ability-types.ts:188

Sort direction for list tool results.


readSortField?

optional readSortField: string

Defined in: packages/sdk/src/types/ability-types.ts:186

Field slug, created_at, or updated_at used to order list tool results.


scope?

optional scope: "member" | "assignment"

Defined in: packages/sdk/src/types/ability-types.ts:208

Scope for the generated agent Form tool record access (reads/writes). Applies to any Form, not only collections.

  • "member" (default): all of the current Member's records, including from prior Assignments (lifetime history).
  • "assignment": only records linked to the current Assignment via AssignmentDataRecordAssociation. Use this when the agent should never see or modify records from a prior Assignment for the same Member.

Omit when the value is "member" so existing configs round-trip without churn.


writeFields?

optional writeFields: string[]

Defined in: packages/sdk/src/types/ability-types.ts:190

Field slugs the agent can write/update. If empty/undefined, all fields are writable.