Interface: ToolInfo
Makaio Framework / tools-core / ToolInfo
Interface: ToolInfo
Section titled “Interface: ToolInfo”Defined in: ../../../tools/core/src/types.ts:263
Info structure returned from registry list operations. Includes inputSchema as JSON Schema for format conversion (e.g., OpenAI).
Properties
Section titled “Properties”annotations?
Section titled “annotations?”
optionalannotations?:object
Defined in: ../../../tools/core/src/types.ts:271
Optional behavior annotations
destructive?
Section titled “destructive?”
optionaldestructive?:boolean
Tool may permanently delete or modify data
idempotent?
Section titled “idempotent?”
optionalidempotent?:boolean
Calling the tool multiple times with same input has same effect
readOnly?
Section titled “readOnly?”
optionalreadOnly?:boolean
Tool only reads data, doesn’t modify anything
requiresApproval?
Section titled “requiresApproval?”
optionalrequiresApproval?:boolean
Tool execution requires user approval
description
Section titled “description”description:
string
Defined in: ../../../tools/core/src/types.ts:267
Tool description
inputSchema?
Section titled “inputSchema?”
optionalinputSchema?:Record<string,unknown>
Defined in: ../../../tools/core/src/types.ts:273
JSON Schema for input parameters (for format conversion)
name:
string
Defined in: ../../../tools/core/src/types.ts:265
Tool name
toolsetName
Section titled “toolsetName”toolsetName:
string
Defined in: ../../../tools/core/src/types.ts:269
Toolset this tool belongs to