core[minor]: Add status field to tool (#6268)

* core[minor]: Add status field to tool

* chore: lint files

* update message uti;s

* drop custom error handling in tool

* undefined status if neither passed during concat

* refactor to default success

langchain-core/src/messages/base.ts

@@ -140,6 +140,24 @@ export function mergeContent(
   }
 }
 
+/**
+ * 'Merge' two statuses. If either value passed is 'error', it will return 'error'. Else
+ * it will return 'success'.
+ *
+ * @param {"success" | "error" | undefined} left The existing value to 'merge' with the new value.
+ * @param {"success" | "error" | undefined} right The new value to 'merge' with the existing value
+ * @returns {"success" | "error"} The 'merged' value.
+ */
+export function _mergeStatus(
+  left?: "success" | "error",
+  right?: "success" | "error"
+): "success" | "error" | undefined {
+  if (left === "error" || right === "error") {
+    return "error";
+  }
+  return "success";
+}
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function stringifyWithDepthLimit(obj: any, depthLimit: number): string {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

langchain-core/src/messages/tool.ts

@@ -6,6 +6,7 @@ import {
   _mergeDicts,
   type MessageType,
   _mergeObj,
+  _mergeStatus,
 } from "./base.js";
 
 export interface ToolMessageFieldsWithToolCallId extends BaseMessageFields {
@@ -19,6 +20,11 @@ export interface ToolMessageFieldsWithToolCallId extends BaseMessageFields {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   artifact?: any;
   tool_call_id: string;
+  /**
+   * Status of the tool invocation.
+   * @version 0.2.19
+   */
+  status?: "success" | "error";
 }
 
 /**
@@ -34,6 +40,12 @@ export class ToolMessage extends BaseMessage {
     return { tool_call_id: "tool_call_id" };
   }
 
+  /**
+   * Status of the tool invocation.
+   * @version 0.2.19
+   */
+  status?: "success" | "error";
+
   tool_call_id: string;
 
   /**
@@ -66,6 +78,7 @@ export class ToolMessage extends BaseMessage {
     super(fields);
     this.tool_call_id = fields.tool_call_id;
     this.artifact = fields.artifact;
+    this.status = fields.status;
   }
 
   _getType(): MessageType {
@@ -92,6 +105,12 @@ export class ToolMessage extends BaseMessage {
 export class ToolMessageChunk extends BaseMessageChunk {
   tool_call_id: string;
 
+  /**
+   * Status of the tool invocation.
+   * @version 0.2.19
+   */
+  status?: "success" | "error";
+
   /**
    * Artifact of the Tool execution which is not meant to be sent to the model.
    *
@@ -106,6 +125,7 @@ export class ToolMessageChunk extends BaseMessageChunk {
     super(fields);
     this.tool_call_id = fields.tool_call_id;
     this.artifact = fields.artifact;
+    this.status = fields.status;
   }
 
   static lc_name() {
@@ -130,6 +150,7 @@ export class ToolMessageChunk extends BaseMessageChunk {
       artifact: _mergeObj(this.artifact, chunk.artifact),
       tool_call_id: this.tool_call_id,
       id: this.id ?? chunk.id,
+      status: _mergeStatus(this.status, chunk.status),
     });
   }
 

langchain-core/src/runnables/remote.ts

@@ -86,6 +86,7 @@ function revive(obj: any): any {
         return new ToolMessage({
           content: obj.content,
           tool_call_id: obj.tool_call_id,
+          status: obj.status,
         });
       }
       if (obj.type === "AIMessage" || obj.type === "ai") {
@@ -119,6 +120,7 @@ function revive(obj: any): any {
         return new ToolMessageChunk({
           content: obj.content,
           tool_call_id: obj.tool_call_id,
+          status: obj.status,
         });
       }
       if (obj.type === "AIMessageChunk") {

langchain-core/src/tools/index.ts

@@ -212,7 +212,8 @@ export abstract class StructuredTool<
     let result;
     try {
       result = await this._call(parsed, runManager, config);
-    } catch (e) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } catch (e: any) {
       await runManager?.handleToolError(e);
       throw e;
     }
@@ -512,12 +513,11 @@ export function tool<T extends ZodObjectAny | z.ZodString = ZodObjectAny>(
   // If the schema is not provided, or it's a string schema, create a DynamicTool
   if (!fields.schema || !("shape" in fields.schema) || !fields.schema.shape) {
     return new DynamicTool({
-      name: fields.name,
+      ...fields,
       description:
         fields.description ??
         fields.schema?.description ??
         `${fields.name} tool`,
-      responseFormat: fields.responseFormat,
       func,
     });
   }
@@ -526,7 +526,7 @@ export function tool<T extends ZodObjectAny | z.ZodString = ZodObjectAny>(
     fields.description ?? fields.schema.description ?? `${fields.name} tool`;
 
   return new DynamicStructuredTool<T extends ZodObjectAny ? T : ZodObjectAny>({
-    name: fields.name,
+    ...fields,
     description,
     schema: fields.schema as T extends ZodObjectAny ? T : ZodObjectAny,
     // TODO: Consider moving into DynamicStructuredTool constructor
@@ -547,7 +547,6 @@ export function tool<T extends ZodObjectAny | z.ZodString = ZodObjectAny>(
         );
       });
     },
-    responseFormat: fields.responseFormat,
   });
 }