Add error handling properties to language model tool results

Author: zhichli

src/vs/workbench/api/browser/mainThreadLanguageModelTools.ts

@@ -57,10 +57,12 @@ export class MainThreadLanguageModelTools extends Disposable implements MainThre
 			token ?? CancellationToken.None,
 		);
 
-		// Only return content and metadata to EH
 		const out: Dto<IToolResult> = {
 			content: result.content,
-			toolMetadata: result.toolMetadata
+			toolResultMessage: result.toolResultMessage,
+			toolResultError: result.toolResultError,
+			toolMetadata: result.toolMetadata,
+			hasError: result.hasError
 		};
 		return toolResultHasBuffers(result) ? new SerializableObjectWithBuffers(out) : out;
 	}

src/vs/workbench/api/common/extHostTypeConverters.ts

@@ -3594,7 +3594,7 @@ export namespace LanguageModelToolSource {
 
 export namespace LanguageModelToolResult {
 	export function to(result: IToolResult): vscode.LanguageModelToolResult {
-		return new types.LanguageModelToolResult(result.content.map(item => {
+		const toolResult = new types.LanguageModelToolResult(result.content.map(item => {
 			if (item.kind === 'text') {
 				return new types.LanguageModelTextPart(item.value, item.audience);
 			} else if (item.kind === 'data') {
@@ -3603,6 +3603,21 @@ export namespace LanguageModelToolResult {
 				return new types.LanguageModelPromptTsxPart(item.value);
 			}
 		}));
+
+		if (result.toolResultMessage) {
+			(toolResult as vscode.ExtendedLanguageModelToolResult).toolResultMessage = typeof result.toolResultMessage === 'string' ? result.toolResultMessage : MarkdownString.to(result.toolResultMessage);
+		}
+		if (result.toolMetadata) {
+			(toolResult as vscode.ExtendedLanguageModelToolResult).toolMetadata = result.toolMetadata;
+		}
+		if (result.toolResultError) {
+			(toolResult as vscode.ExtendedLanguageModelToolResult).toolResultError = result.toolResultError;
+		}
+		if (result.hasError !== undefined) {
+			(toolResult as vscode.ExtendedLanguageModelToolResult).hasError = result.hasError;
+		}
+
+		return toolResult;
 	}
 
 	export function from(result: vscode.ExtendedLanguageModelToolResult, extension: IExtensionDescription): Dto<IToolResult> | SerializableObjectWithBuffers<Dto<IToolResult>> {
@@ -3648,6 +3663,9 @@ export namespace LanguageModelToolResult {
 			}),
 			toolResultMessage: MarkdownString.fromStrict(result.toolResultMessage),
 			toolResultDetails: result.toolResultDetails?.map(detail => URI.isUri(detail) ? detail : Location.from(detail as vscode.Location)),
+			toolResultError: result.toolResultError,
+			toolMetadata: result.toolMetadata,
+			hasError: result.hasError,
 		};
 
 		return hasBuffers ? new SerializableObjectWithBuffers(dto) : dto;
@@ -3666,9 +3684,18 @@ export namespace LanguageModelToolResult2 {
 			}
 		}));
 
+		if (result.toolResultMessage) {
+			(toolResult as vscode.ExtendedLanguageModelToolResult).toolResultMessage = typeof result.toolResultMessage === 'string' ? result.toolResultMessage : MarkdownString.to(result.toolResultMessage);
+		}
 		if (result.toolMetadata) {
 			(toolResult as vscode.ExtendedLanguageModelToolResult).toolMetadata = result.toolMetadata;
 		}
+		if (result.toolResultError) {
+			(toolResult as vscode.ExtendedLanguageModelToolResult).toolResultError = result.toolResultError;
+		}
+		if (result.hasError !== undefined) {
+			(toolResult as vscode.ExtendedLanguageModelToolResult).hasError = result.hasError;
+		}
 
 		return toolResult;
 	}
@@ -3734,7 +3761,9 @@ export namespace LanguageModelToolResult2 {
 			}),
 			toolResultMessage: MarkdownString.fromStrict(result.toolResultMessage),
 			toolResultDetails: detailsDto,
+			toolResultError: result.toolResultError,
 			toolMetadata: result.toolMetadata,
+			hasError: result.hasError,
 		};
 
 		return hasBuffers ? new SerializableObjectWithBuffers(dto) : dto;

src/vs/workbench/contrib/chat/common/languageModelToolsService.ts

@@ -208,6 +208,8 @@ export interface IToolResult {
 	toolMetadata?: unknown;
 	/** Whether to ask the user to confirm these tool results. Overrides {@link IToolConfirmationMessages.confirmResults}. */
 	confirmResults?: boolean;
+	/** Whether there was an error calling the tool. The tool may still have partially succeeded. */
+	hasError?: boolean;
 }
 
 export function toolContentToA11yString(part: IToolResult['content']) {

src/vscode-dts/vscode.proposed.chatParticipantPrivate.d.ts

@@ -257,6 +257,7 @@ declare module 'vscode' {
 	export class ExtendedLanguageModelToolResult extends LanguageModelToolResult {
 		toolResultMessage?: string | MarkdownString;
 		toolResultDetails?: Array<Uri | Location>;
+		toolResultError?: string;
 		toolMetadata?: unknown;
 		/** Whether there was an error calling the tool. The tool may still have partially succeeded. */
 		hasError?: boolean;