tool
Module: @vibex/core/tool
Tool Types - Shared interfaces for tools
Interfaces
ToolDefinition
View sourceCanonical tool definition that AI SDK-compatible runtimes expect.
Properties:
| Name | Type | Description |
|---|---|---|
description | string | |
inputSchema | z.ZodSchema | unknown | |
execute | (args: unknown, context?: unknown) => Promise<unknown> |
ToolMetadata
View sourceTool metadata for discovery and UI curation.
Properties:
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
description | string | |
category | string | |
icon | string | (optional) |
tags | string[] | (optional) |
features | string[] | (optional) |
tools | string[] | |
functions | unknown[] | (optional) |
functionDetails | Array<\{ name: string; description: string; parameters?: unknown; inputSchema?: unknown; \}> | (optional) |
configSchema | unknown | (optional) |
enabled | boolean | (optional) |
Types
CoreTool
View sourcetype CoreTool = ToolDefinitionToolInfo
View sourcetype ToolInfo = ToolMetadata