Interface: DefineZodToolConfig<TSchema>

Defined in: zod.ts:21

#Type Parameters

#TSchema

TSchema extends ZodLike

#Properties

#category?

optional category?: string

Defined in: zod.ts:39

---

#description?

optional description?: string

Defined in: zod.ts:23

---

#dispose?

optional dispose?: () => MaybePromise<void>

Defined in: zod.ts:37

#Returns

MaybePromise<void>

---

#execute?

optional execute?: (args, context) => any

Defined in: zod.ts:32

#Parameters

args

InferZodOutput<TSchema>

context

ToolExecutionContext

#Returns

any

---

#init?

optional init?: () => MaybePromise<void>

Defined in: zod.ts:36

#Returns

MaybePromise<void>

---

#name

name: string

Defined in: zod.ts:22

---

#requiresConfirmation?

optional requiresConfirmation?: boolean

Defined in: zod.ts:31

---

#schema

schema: TSchema

Defined in: zod.ts:24

---

#tags?

optional tags?: string[]

Defined in: zod.ts:38

---

#toJsonSchema?

optional toJsonSchema?: (schema) => JSONSchema7

Defined in: zod.ts:30

Convert the Zod schema to JSON Schema. Users must supply this themselves (e.g. via zod-to-json-schema), keeping the zod dependency entirely optional.

#Parameters

schema

TSchema

#Returns

JSONSchema7

Explore nearby

• Peer
  FetchUrlConfig

  Auto-generated API reference for FetchUrlConfig.

• Peer
  FilesystemConfig

  Auto-generated API reference for FilesystemConfig.

• Peer
  ShellConfig

  Auto-generated API reference for ShellConfig.