@voltagent/core 0.1.13 → 0.1.14

package/README.md

@@ -100,7 +100,7 @@ import { openai } from "@ai-sdk/openai"; // Example model
 // Define a simple agent
 const agent = new Agent({
   name: "my-agent",
-  description: "A helpful assistant that answers questions without using tools",
+  instructions: "A helpful assistant that answers questions without using tools",
   // Note: You can swap VercelAIProvider and openai with other supported providers/models
   llm: new VercelAIProvider(),
   model: openai("gpt-4o-mini"),

package/dist/index.d.ts

@@ -440,10 +440,6 @@ type AgentOptions = {
      * Agent name
      */
     name: string;
-    /**
-     * Agent description
-     */
-    description?: string;
     /**
      * Memory storage for the agent (optional)
      * Set to false to explicitly disable memory
@@ -461,7 +457,28 @@ type AgentOptions = {
      * Sub-agents that this agent can delegate tasks to
      */
     subAgents?: any[];
-};
+} & ({
+    /**
+     * @deprecated Use `instructions` instead.
+     * Agent description (deprecated, use instructions)
+     */
+    description: string;
+    /**
+     * Agent instructions. This is the preferred field.
+     */
+    instructions?: string;
+} | {
+    /**
+     * @deprecated Use `instructions` instead.
+     * Agent description (deprecated, use instructions)
+     */
+    description?: undefined;
+    /**
+     * Agent instructions. This is the preferred field.
+     * Required if description is not provided.
+     */
+    instructions: string;
+});
 /**
  * Provider instance type helper
  */
@@ -1774,7 +1791,7 @@ declare class SubAgentManager {
      * @param baseDescription - The base description of the agent
      * @param agentsMemory - Optional string containing formatted memory from previous agent interactions
      */
-    generateSupervisorSystemMessage(baseDescription: string, agentsMemory?: string): string;
+    generateSupervisorSystemMessage(baseInstructions: string, agentsMemory?: string): string;
     /**
      * Check if the agent has sub-agents
      */
@@ -2008,9 +2025,13 @@ declare class Agent<TProvider extends {
      */
     readonly name: string;
     /**
-     * Agent description
+     * @deprecated Use `instructions` instead. Will be removed in a future version.
      */
     readonly description: string;
+    /**
+     * Agent instructions. This is the preferred field over `description`.
+     */
+    readonly instructions: string;
     /**
      * The LLM provider to use
      */
@@ -2054,7 +2075,7 @@ declare class Agent<TProvider extends {
     /**
      * Create a new agent
      */
-    constructor(options: Omit<AgentOptions, "provider" | "model"> & TProvider & {
+    constructor(options: AgentOptions & TProvider & {
         model: ModelType<TProvider>;
         subAgents?: Agent<any>[];
         maxHistoryEntries?: number;
@@ -2103,6 +2124,7 @@ declare class Agent<TProvider extends {
         id: string;
         name: string;
         description: string;
+        instructions: string;
         status: string;
         model: string;
         node_id: string;

package/dist/index.js

@@ -4318,11 +4318,11 @@ var SubAgentManager = class {
    * @param baseDescription - The base description of the agent
    * @param agentsMemory - Optional string containing formatted memory from previous agent interactions
    */
-  generateSupervisorSystemMessage(baseDescription, agentsMemory = "") {
+  generateSupervisorSystemMessage(baseInstructions, agentsMemory = "") {
     if (this.subAgents.length === 0) {
-      return baseDescription;
+      return baseInstructions;
     }
-    const subAgentList = this.subAgents.map((agent) => `- ${agent.name}: ${agent.description}`).join("\n");
+    const subAgentList = this.subAgents.map((agent) => `- ${agent.name}: ${agent.instructions}`).join("\n");
     return `
     You are a supervisor agent that coordinates between specialized agents:
 
@@ -4331,7 +4331,7 @@ ${subAgentList}
 </specialized_agents>
 
 <instructions>
-${baseDescription}
+${baseInstructions}
 </instructions>
 
 <guidelines>
@@ -4905,15 +4905,16 @@ var Agent = class {
         context
       );
     }, "addAgentEvent");
-    var _a;
+    var _a, _b, _c;
     this.id = options.id || options.name;
     this.name = options.name;
-    this.description = options.description || "A helpful AI assistant";
+    this.instructions = (_b = (_a = options.instructions) != null ? _a : options.description) != null ? _b : "A helpful AI assistant";
+    this.description = this.instructions;
     this.llm = options.llm;
     this.model = options.model;
     this.retriever = options.retriever;
     this.voice = options.voice;
-    this.markdown = (_a = options.markdown) != null ? _a : false;
+    this.markdown = (_c = options.markdown) != null ? _c : false;
     if (options.hooks) {
       this.hooks = options.hooks;
     } else {
@@ -4937,7 +4938,7 @@ var Agent = class {
       historyEntryId,
       contextMessages
     }) {
-      let baseDescription = this.description || "";
+      let baseInstructions = this.instructions || "";
       let toolInstructions = "";
       const toolkits = this.toolManager.getToolkits();
       for (const toolkit of toolkits) {
@@ -4948,14 +4949,14 @@ ${toolkit.instructions}`;
         }
       }
       if (toolInstructions) {
-        baseDescription = `${baseDescription}${toolInstructions}`;
+        baseInstructions = `${baseInstructions}${toolInstructions}`;
       }
       if (this.markdown) {
-        baseDescription = `${baseDescription}
+        baseInstructions = `${baseInstructions}
 
 Use markdown to format your answers.`;
       }
-      let description = baseDescription;
+      let finalInstructions = baseInstructions;
       if (this.retriever && input && historyEntryId) {
         const retrieverNodeId = createNodeId("retriever" /* RETRIEVER */, this.retriever.tool.name, this.id);
         const eventEmitter = AgentEventEmitter.getInstance();
@@ -4975,7 +4976,7 @@ Use markdown to format your answers.`;
         try {
           const context = yield this.retriever.retrieve(input);
           if (context == null ? void 0 : context.trim()) {
-            description = `${description}
+            finalInstructions = `${finalInstructions}
 
 Relevant Context:
 ${context}`;
@@ -5000,15 +5001,18 @@ ${context}`;
       }
       if (this.subAgentManager.hasSubAgents()) {
         const agentsMemory = yield this.prepareAgentsMemory(contextMessages);
-        description = this.subAgentManager.generateSupervisorSystemMessage(description, agentsMemory);
+        finalInstructions = this.subAgentManager.generateSupervisorSystemMessage(
+          finalInstructions,
+          agentsMemory
+        );
         return {
           role: "system",
-          content: description
+          content: finalInstructions
         };
       }
       return {
         role: "system",
-        content: `You are ${this.name}. ${description}`
+        content: `You are ${this.name}. ${finalInstructions}`
       };
     });
   }
@@ -5165,6 +5169,7 @@ ${context}`;
       id: this.id,
       name: this.name,
       description: this.description,
+      instructions: this.instructions,
       status: "idle",
       model: this.getModelName(),
       // Create a node representing this agent