Interface: DataAccessAbilityConfig
Defined in: packages/sdk/src/types/ability-types.ts:179
Config for data_access ability
Properties
autoCreate?
optionalautoCreate:boolean
Defined in: packages/sdk/src/types/ability-types.ts:209
When true, auto-create a record for the assignment if one doesn't exist (default: false)
canCreate?
optionalcanCreate:boolean
Defined in: packages/sdk/src/types/ability-types.ts:183
Whether the agent can create new records (default: false)
canDelete?
optionalcanDelete:boolean
Defined in: packages/sdk/src/types/ability-types.ts:195
Whether the agent can delete records (default: false)
canEdit?
optionalcanEdit:boolean
Defined in: packages/sdk/src/types/ability-types.ts:187
Whether the agent can update existing records (default: false)
canGeolocate?
optionalcanGeolocate:boolean
Defined in: packages/sdk/src/types/ability-types.ts:193
Whether the agent can search records by geographic location (default: false)
canListAll?
optionalcanListAll:boolean
Defined in: packages/sdk/src/types/ability-types.ts:191
Whether the agent can list all members' records (default: false)
canRead?
optionalcanRead:boolean
Defined in: packages/sdk/src/types/ability-types.ts:185
Whether the agent can list and search records (default: true)
canVerify?
optionalcanVerify:boolean
Defined in: packages/sdk/src/types/ability-types.ts:189
Whether the agent can verify record data (default: false)
createFields?
optionalcreateFields:string[]
Defined in: packages/sdk/src/types/ability-types.ts:207
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:181
UUID of the data type to provide tools for
readFields?
optionalreadFields:string[]
Defined in: packages/sdk/src/types/ability-types.ts:197
Field slugs the agent can read. If empty/undefined, all fields are readable.
readLimit?
optionalreadLimit:number
Defined in: packages/sdk/src/types/ability-types.ts:199
Maximum records returned by list tools. If empty/undefined, the default page size is used.
readSortDirection?
optionalreadSortDirection:"asc"|"desc"
Defined in: packages/sdk/src/types/ability-types.ts:203
Sort direction for list tool results.
readSortField?
optionalreadSortField:string
Defined in: packages/sdk/src/types/ability-types.ts:201
Field slug, created_at, or updated_at used to order list tool results.
scope?
optionalscope:"member"|"assignment"
Defined in: packages/sdk/src/types/ability-types.ts:223
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?
optionalwriteFields:string[]
Defined in: packages/sdk/src/types/ability-types.ts:205
Field slugs the agent can write/update. If empty/undefined, all fields are writable.