Skip to main content

Interface: ActivityAsToolOptions

strands.ActivityAsToolOptions

Options accepted by activityAsTool.

name defaults to the activity function's .name. description defaults to an empty string and SHOULD be supplied so the model has signal about when to call the tool. inputSchema describes the activity's single argument; pass either a literal JSON Schema object or a Zod schema, which is converted to JSON Schema for you.

Properties​

activityOptions​

• Optional activityOptions: ActivityOptions

description​

• Optional description: string

inputSchema​

• Optional inputSchema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | JSONSchema7

name​

• Optional name: string