Skip to Content

tool

Module: @vibex/core/tool

Tool Types - Shared interfaces for tools

Interfaces

ToolDefinition

View source

Canonical tool definition that AI SDK-compatible runtimes expect.

Properties:

NameTypeDescription
descriptionstring
inputSchemaz.ZodSchema | unknown
execute(args: unknown, context?: unknown) => Promise<unknown>

ToolMetadata

View source

Tool metadata for discovery and UI curation.

Properties:

NameTypeDescription
idstring
namestring
descriptionstring
categorystring
iconstring(optional)
tagsstring[](optional)
featuresstring[](optional)
toolsstring[]
functionsunknown[](optional)
functionDetailsArray<\{ name: string; description: string; parameters?: unknown; inputSchema?: unknown; \}>(optional)
configSchemaunknown(optional)
enabledboolean(optional)

Types

CoreTool

View source
type CoreTool = ToolDefinition

ToolInfo

View source
type ToolInfo = ToolMetadata