Interface: DefineToolConfig<TSchema>

Defined in: packages/core/src/types/tool.ts:121

Config for defineTool: schema is narrowed to a const type for inference.

#Type Parameters

#TSchema

TSchema extends JSONSchema7

#Properties

#category?

optional category?: string

Defined in: packages/core/src/types/tool.ts:133

---

#description?

optional description?: string

Defined in: packages/core/src/types/tool.ts:123

---

#dispose?

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

Defined in: packages/core/src/types/tool.ts:131

#Returns

MaybePromise<void>

---

#execute?

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

Defined in: packages/core/src/types/tool.ts:126

#Parameters

args

InferSchemaType<TSchema>

context

ToolExecutionContext

#Returns

unknown

---

#init?

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

Defined in: packages/core/src/types/tool.ts:130

#Returns

MaybePromise<void>

---

#name

name: string

Defined in: packages/core/src/types/tool.ts:122

---

#requiresConfirmation?

optional requiresConfirmation?: boolean

Defined in: packages/core/src/types/tool.ts:125

---

#schema?

optional schema?: TSchema

Defined in: packages/core/src/types/tool.ts:124

---

#tags?

optional tags?: string[]

Defined in: packages/core/src/types/tool.ts:132

Explore nearby

• Peer
  ActivateSkillsResult

  Auto-generated API reference for ActivateSkillsResult.

• Peer
  AdapterCapabilities

  Auto-generated API reference for AdapterCapabilities.

• Peer
  AdapterContext

  Auto-generated API reference for AdapterContext.