Interface: AguiTool

Defined in: src/types/agui.ts:127

A frontend tool definition offered by the AG-UI client to the agent.

Remarks

parameters is a JSON Schema document, carried through as opaque JSON.

Example

const tool: AguiTool = {
  name: 'highlightRow',
  description: 'Highlight a row in the table',
  parameters: { type: 'object', properties: { rowId: { type: 'string' } } },
};

Properties

description?

optional description?: string

Defined in: src/types/agui.ts:129

What the tool does.

name

name: string

Defined in: src/types/agui.ts:131

Tool name.

parameters?

optional parameters?: JsonValue

Defined in: src/types/agui.ts:133

JSON Schema of the tool parameters.