Skip to main content

ToolFrameworkResult

@codebolt/codeboltjs


Interface: ToolFrameworkResult

Defined in: packages/codeboltjs/src/tools/types.ts:152

Result of a tool execution

Properties

PropertyTypeDescriptionDefined in
error?{ message: string; type?: ToolErrorType; }If this property is present, the tool call is considered a failure.packages/codeboltjs/src/tools/types.ts:168
error.messagestring-packages/codeboltjs/src/tools/types.ts:169
error.type?ToolErrorType-packages/codeboltjs/src/tools/types.ts:170
llmContentPartListUnionContent meant to be included in LLM history. This should represent the factual outcome of the tool execution.packages/codeboltjs/src/tools/types.ts:157
returnDisplayToolResultDisplayMarkdown string for user display. This provides a user-friendly summary or visualization of the result.packages/codeboltjs/src/tools/types.ts:163