@aigne/core 1.16.0 → 1.18.0

package/lib/esm/agents/ai-agent.js

@@ -1,6 +1,4 @@
 import { z } from "zod";
-import { DefaultMemory } from "../memory/default-memory.js";
-import { MemoryAgent } from "../memory/memory.js";
 import { MESSAGE_KEY, PromptBuilder } from "../prompt/prompt-builder.js";
 import { AgentMessageTemplate, ToolMessageTemplate } from "../prompt/template.js";
 import { checkArguments, isEmpty } from "../utils/type-utils.js";
@@ -98,14 +96,7 @@ export class AIAgent extends Agent {
      * @param options Configuration options for the AI agent
      */
     constructor(options) {
-        super({
-            ...options,
-            memory: !options.memory
-                ? undefined
-                : Array.isArray(options.memory) || options.memory instanceof MemoryAgent
-                    ? options.memory
-                    : new DefaultMemory(options.memory === true ? {} : options.memory),
-        });
+        super(options);
         checkArguments("AIAgent", aiAgentOptionsSchema, options);
         this.model = options.model;
         this.instructions =
@@ -185,26 +176,26 @@ export class AIAgent extends Agent {
      *
      * @protected
      */
-    async *process(input, context) {
-        const model = this.model ?? context.model;
+    async *process(input, options) {
+        const model = this.model ?? options.context.model;
         if (!model)
             throw new Error("model is required to run AIAgent");
         const { toolAgents, ...modelInput } = await this.instructions.build({
+            ...options,
             agent: this,
             input,
             model,
-            context,
         });
         const toolsMap = new Map(toolAgents?.map((i) => [i.name, i]));
         if (this.toolChoice === "router") {
-            yield* this._processRouter(input, model, modelInput, context, toolsMap);
+            yield* this._processRouter(input, model, modelInput, options, toolsMap);
             return;
         }
         const toolCallMessages = [];
         const outputKey = this.outputKey || MESSAGE_KEY;
         for (;;) {
             const modelOutput = {};
-            const stream = await context.invoke(model, { ...modelInput, messages: modelInput.messages.concat(toolCallMessages) }, { streaming: true });
+            const stream = await options.context.invoke(model, { ...modelInput, messages: modelInput.messages.concat(toolCallMessages) }, { streaming: true });
             for await (const value of stream) {
                 if (value.delta.text?.text) {
                     yield { delta: { text: { [outputKey]: value.delta.text.text } } };
@@ -222,7 +213,7 @@ export class AIAgent extends Agent {
                     if (!tool)
                         throw new Error(`Tool not found: ${call.function.name}`);
                     // NOTE: should pass both arguments (model generated) and input (user provided) to the tool
-                    const output = await this.invokeSkill(tool, { ...input, ...call.function.arguments }, context).catch((error) => {
+                    const output = await this.invokeSkill(tool, { ...input, ...call.function.arguments }, options).catch((error) => {
                         if (!this.catchToolsError) {
                             return Promise.reject(error);
                         }
@@ -272,15 +263,15 @@ export class AIAgent extends Agent {
      *
      * @protected
      */
-    async *_processRouter(input, model, modelInput, context, toolsMap) {
-        const { toolCalls: [call] = [], } = await context.invoke(model, modelInput);
+    async *_processRouter(input, model, modelInput, options, toolsMap) {
+        const { toolCalls: [call] = [], } = await options.context.invoke(model, modelInput);
         if (!call) {
             throw new Error("Router toolChoice requires exactly one tool to be executed");
         }
         const tool = toolsMap.get(call.function.name);
         if (!tool)
             throw new Error(`Tool not found: ${call.function.name}`);
-        const stream = await context.invoke(tool, { ...call.function.arguments, ...input }, { streaming: true, sourceAgent: this });
+        const stream = await options.context.invoke(tool, { ...call.function.arguments, ...input }, { streaming: true, sourceAgent: this });
         yield* stream;
     }
 }

package/lib/esm/agents/chat-model.d.ts

@@ -1,6 +1,5 @@
-import type { Context } from "../aigne/context.js";
 import type { PromiseOrValue } from "../utils/type-utils.js";
-import { Agent, type AgentProcessResult, type Message } from "./agent.js";
+import { Agent, type AgentInvokeOptions, type AgentProcessResult, type Message } from "./agent.js";
 /**
  * ChatModel is an abstract base class for interacting with Large Language Models (LLMs).
  *
@@ -61,10 +60,10 @@ export declare abstract class ChatModel extends Agent<ChatModelInput, ChatModelO
      * Primarily checks if token usage exceeds limits, throwing an exception if limits are exceeded
      *
      * @param input Input message
-     * @param context Execution context
+     * @param options Options for invoking the agent
      * @throws Error if token usage exceeds maximum limit
      */
-    protected preprocess(input: ChatModelInput, context: Context): Promise<void>;
+    protected preprocess(input: ChatModelInput, options: AgentInvokeOptions): Promise<void>;
     /**
      * Performs postprocessing operations after handling output
      *
@@ -72,9 +71,9 @@ export declare abstract class ChatModel extends Agent<ChatModelInput, ChatModelO
      *
      * @param input Input message
      * @param output Output message
-     * @param context Execution context
+     * @param options Options for invoking the agent
      */
-    protected postprocess(input: ChatModelInput, output: ChatModelOutput, context: Context): void;
+    protected postprocess(input: ChatModelInput, output: ChatModelOutput, options: AgentInvokeOptions): Promise<void>;
     /**
      * Processes input messages and generates model responses
      *
@@ -92,10 +91,10 @@ export declare abstract class ChatModel extends Agent<ChatModelInput, ChatModelO
      * - Tool call processing if applicable
      *
      * @param input - The standardized input containing messages and model options
-     * @param context - The execution context with settings and state
+     * @param options - The options for invoking the agent, including context and limits
      * @returns A promise or direct value containing the model's response
      */
-    abstract process(input: ChatModelInput, context: Context): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
+    abstract process(input: ChatModelInput, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
 }
 /**
  * Input message format for ChatModel

package/lib/esm/agents/chat-model.js

@@ -75,12 +75,12 @@ export class ChatModel extends Agent {
      * Primarily checks if token usage exceeds limits, throwing an exception if limits are exceeded
      *
      * @param input Input message
-     * @param context Execution context
+     * @param options Options for invoking the agent
      * @throws Error if token usage exceeds maximum limit
      */
-    async preprocess(input, context) {
-        super.preprocess(input, context);
-        const { limits, usage } = context;
+    async preprocess(input, options) {
+        super.preprocess(input, options);
+        const { limits, usage } = options.context;
         const usedTokens = usage.outputTokens + usage.inputTokens;
         if (limits?.maxTokens && usedTokens >= limits.maxTokens) {
             throw new Error(`Exceeded max tokens ${usedTokens}/${limits.maxTokens}`);
@@ -109,9 +109,9 @@ export class ChatModel extends Agent {
      *
      * @param input Input message
      * @param output Output message
-     * @param context Execution context
+     * @param options Options for invoking the agent
      */
-    postprocess(input, output, context) {
+    async postprocess(input, output, options) {
         // Restore original tool names in the output
         if (output.toolCalls?.length) {
             const toolsMap = input._toolsMap;
@@ -125,11 +125,11 @@ export class ChatModel extends Agent {
                 }
             }
         }
-        super.postprocess(input, output, context);
+        super.postprocess(input, output, options);
         const { usage } = output;
         if (usage) {
-            context.usage.outputTokens += usage.outputTokens;
-            context.usage.inputTokens += usage.inputTokens;
+            options.context.usage.outputTokens += usage.outputTokens;
+            options.context.usage.inputTokens += usage.inputTokens;
         }
     }
 }

package/lib/esm/agents/mcp-agent.d.ts

@@ -1,14 +1,13 @@
 import { Client, type ClientOptions } from "@modelcontextprotocol/sdk/client/index.js";
 import { type SSEClientTransportOptions } from "@modelcontextprotocol/sdk/client/sse.js";
-import { type StdioServerParameters } from "@modelcontextprotocol/sdk/client/stdio.js";
+import type { StdioServerParameters } from "@modelcontextprotocol/sdk/client/stdio.js";
 import { type StreamableHTTPClientTransportOptions } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
 import type { RequestOptions } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import type { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
 import type { CallToolResult, GetPromptResult, Implementation, ReadResourceResult, Request } from "@modelcontextprotocol/sdk/types.js";
 import { type ZodType, z } from "zod";
-import type { Context } from "../aigne/context.js";
 import { type PromiseOrValue } from "../utils/type-utils.js";
-import { Agent, type AgentOptions, type Message } from "./agent.js";
+import { Agent, type AgentInvokeOptions, type AgentOptions, type Message } from "./agent.js";
 export interface MCPAgentOptions extends AgentOptions {
     client: Client;
     prompts?: MCPPrompt[];
@@ -150,10 +149,10 @@ export declare class MCPAgent extends Agent {
      * throws an error if called.
      *
      * @param _input Input message (unused)
-     * @param _context Execution context (unused)
+     * @param _options AgentInvokeOptions (unused)
      * @throws Error This method always throws an error since MCPAgent is not directly invokable
      */
-    process(_input: Message, _context?: Context): Promise<Message>;
+    process(_input: Message, _options: AgentInvokeOptions): Promise<Message>;
     /**
      * Shut down the agent and close the MCP connection.
      *

package/lib/esm/agents/mcp-agent.js

@@ -1,12 +1,13 @@
+import { createStdioClientTransport } from "@aigne/platform-helpers/mcp/stdio-client-transport.js";
 import { Client } from "@modelcontextprotocol/sdk/client/index.js";
 import { SSEClientTransport, } from "@modelcontextprotocol/sdk/client/sse.js";
-import { StdioClientTransport, getDefaultEnvironment, } from "@modelcontextprotocol/sdk/client/stdio.js";
 import { StreamableHTTPClientTransport, } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
 import { UriTemplate } from "@modelcontextprotocol/sdk/shared/uriTemplate.js";
 import pRetry from "p-retry";
 import { z } from "zod";
 import { logger } from "../utils/logger.js";
 import { promptFromMCPPrompt, resourceFromMCPResource, toolFromMCPTool, } from "../utils/mcp-utils.js";
+import { nodejs } from "../utils/nodejs.js";
 import { checkArguments, createAccessorArray } from "../utils/type-utils.js";
 import { Agent } from "./agent.js";
 const MCP_AGENT_CLIENT_NAME = "AIGNE/MCPAgent";
@@ -16,7 +17,7 @@ const DEFAULT_TIMEOUT = () => z.coerce
     .number()
     .int()
     .min(0)
-    .safeParse(process.env.MCP_TIMEOUT || process.env.TIMEOUT).data || 60e3;
+    .safeParse(nodejs.env.MCP_TIMEOUT || nodejs.env.TIMEOUT).data || 60e3;
 function isSSEServerParameters(options) {
     return "url" in options && typeof options.url === "string";
 }
@@ -60,14 +61,7 @@ export class MCPAgent extends Agent {
             return MCPAgent.fromTransport(transport, options);
         }
         if (isStdioServerParameters(options)) {
-            const transport = () => new StdioClientTransport({
-                ...options,
-                env: {
-                    ...getDefaultEnvironment(),
-                    ...options.env,
-                },
-                stderr: "pipe",
-            });
+            const transport = async () => createStdioClientTransport(options);
             return MCPAgent.fromTransport(transport, options);
         }
         return new MCPAgent(options);
@@ -77,7 +71,7 @@ export class MCPAgent extends Agent {
             name: MCP_AGENT_CLIENT_NAME,
             version: MCP_AGENT_CLIENT_VERSION,
         }, undefined, isSSEServerParameters(options) ? { transportCreator, ...options } : undefined);
-        const transport = transportCreator();
+        const transport = await transportCreator();
         logger.debug(`Connecting to MCP server: ${getMCPServerString(options)}`);
         await client.connect(transport);
         const mcpServer = getMCPServerName(client);
@@ -177,10 +171,10 @@ export class MCPAgent extends Agent {
      * throws an error if called.
      *
      * @param _input Input message (unused)
-     * @param _context Execution context (unused)
+     * @param _options AgentInvokeOptions (unused)
      * @throws Error This method always throws an error since MCPAgent is not directly invokable
      */
-    async process(_input, _context) {
+    async process(_input, _options) {
         throw new Error("Method not implemented.");
     }
     /**

package/lib/esm/agents/team-agent.d.ts

@@ -1,6 +1,5 @@
-import type { Context } from "../aigne/context.js";
 import { type PromiseOrValue } from "../utils/type-utils.js";
-import { Agent, type AgentOptions, type AgentProcessResult, type Message } from "./agent.js";
+import { Agent, type AgentInvokeOptions, type AgentOptions, type AgentProcessResult, type Message } from "./agent.js";
 /**
  * Defines the processing modes available for a TeamAgent.
  *
@@ -89,10 +88,10 @@ export declare class TeamAgent<I extends Message, O extends Message> extends Age
      * - In parallel mode: Process input through all agents simultaneously and combine their outputs
      *
      * @param input The message to process
-     * @param context The execution context
+     * @param options The invocation options
      * @returns A stream of message chunks that collectively form the response
      */
-    process(input: I, context: Context): PromiseOrValue<AgentProcessResult<O>>;
+    process(input: I, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<O>>;
     /**
      * Process input sequentially through each agent in the team.
      *
@@ -103,12 +102,12 @@ export declare class TeamAgent<I extends Message, O extends Message> extends Age
      * 4. Updates the team's agent list with any changes that occurred during processing
      *
      * @param input The message to process
-     * @param context The execution context
+     * @param options The invocation options
      * @returns A stream of message chunks from all agents
      *
      * @private
      */
-    _processSequential(input: I, context: Context): PromiseOrValue<AgentProcessResult<O>>;
+    _processSequential(input: I, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<O>>;
     /**
      * Process input in parallel through all agents in the team.
      *
@@ -118,10 +117,10 @@ export declare class TeamAgent<I extends Message, O extends Message> extends Age
      * 3. Updates the team's agent list with any changes that occurred during processing
      *
      * @param input The message to process
-     * @param context The execution context
+     * @param options The invocation options
      * @returns A stream of combined message chunks from all agents
      *
      * @private
      */
-    _processParallel(input: I, context: Context): PromiseOrValue<AgentProcessResult<O>>;
+    _processParallel(input: I, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<O>>;
 }

package/lib/esm/agents/team-agent.js

@@ -83,15 +83,15 @@ export class TeamAgent extends Agent {
      * - In parallel mode: Process input through all agents simultaneously and combine their outputs
      *
      * @param input The message to process
-     * @param context The execution context
+     * @param options The invocation options
      * @returns A stream of message chunks that collectively form the response
      */
-    process(input, context) {
+    process(input, options) {
         switch (this.mode) {
             case ProcessMode.sequential:
-                return this._processSequential(input, context);
+                return this._processSequential(input, options);
             case ProcessMode.parallel:
-                return this._processParallel(input, context);
+                return this._processParallel(input, options);
         }
     }
     /**
@@ -104,18 +104,18 @@ export class TeamAgent extends Agent {
      * 4. Updates the team's agent list with any changes that occurred during processing
      *
      * @param input The message to process
-     * @param context The execution context
+     * @param options The invocation options
      * @returns A stream of message chunks from all agents
      *
      * @private
      */
-    async *_processSequential(input, context) {
+    async *_processSequential(input, options) {
         const output = {};
         // Clone the agents to run, so that we can update the agents list during the loop
         const agents = [...this.skills];
         const newAgents = [];
         for (const agent of agents) {
-            const [o, transferToAgent] = await context.invoke(agent, { ...input, ...output }, { returnActiveAgent: true, streaming: true });
+            const [o, transferToAgent] = await options.context.invoke(agent, { ...input, ...output }, { returnActiveAgent: true, streaming: true });
             for await (const chunk of o) {
                 yield chunk;
                 mergeAgentResponseChunk(output, chunk);
@@ -134,13 +134,13 @@ export class TeamAgent extends Agent {
      * 3. Updates the team's agent list with any changes that occurred during processing
      *
      * @param input The message to process
-     * @param context The execution context
+     * @param options The invocation options
      * @returns A stream of combined message chunks from all agents
      *
      * @private
      */
-    async *_processParallel(input, context) {
-        const result = await Promise.all(this.skills.map((agent) => context.invoke(agent, input, { returnActiveAgent: true, streaming: true })));
+    async *_processParallel(input, options) {
+        const result = await Promise.all(this.skills.map((agent) => options.context.invoke(agent, input, { returnActiveAgent: true, streaming: true })));
         const streams = result.map((i) => i[0]);
         const read = async (index, reader) => {
             const promise = reader.read();

package/lib/esm/agents/user-agent.d.ts

@@ -1,7 +1,6 @@
-import { ReadableStream } from "node:stream/web";
 import type { Context } from "../aigne/context.js";
 import { type MessagePayload } from "../aigne/message-queue.js";
-import { Agent, type AgentOptions, type AgentProcessResult, type FunctionAgentFn, type Message } from "./agent.js";
+import { Agent, type AgentInvokeOptions, type AgentOptions, type AgentProcessResult, type FunctionAgentFn, type Message } from "./agent.js";
 export interface UserAgentOptions<I extends Message = Message, O extends Message = Message> extends AgentOptions<I, O> {
     context: Context;
     process?: FunctionAgentFn<I, O>;
@@ -14,14 +13,14 @@ export declare class UserAgent<I extends Message = Message, O extends Message =
     private _process?;
     private activeAgent?;
     protected subscribeToTopics(context: Pick<Context, "subscribe">): void;
-    protected publishToTopics(output: O, context: Context): Promise<void>;
+    protected publishToTopics(output: O, options: AgentInvokeOptions): Promise<void>;
     invoke: Agent<I, O>["invoke"];
-    process(input: I, context: Context): Promise<AgentProcessResult<O>>;
+    process(input: I, options: AgentInvokeOptions): Promise<AgentProcessResult<O>>;
     publish: Context["publish"];
     subscribe: Context["subscribe"];
     unsubscribe: Context["unsubscribe"];
     get stream(): ReadableStream<MessagePayload & {
         topic: string;
     }>;
-    protected checkAgentInvokesUsage(_context: Context): void;
+    protected checkAgentInvokesUsage(_options: AgentInvokeOptions): void;
 }

package/lib/esm/agents/user-agent.js

@@ -1,4 +1,3 @@
-import { ReadableStream } from "node:stream/web";
 import { toMessagePayload } from "../aigne/message-queue.js";
 import { orArrayToArray } from "../utils/type-utils.js";
 import { Agent, } from "./agent.js";
@@ -19,21 +18,21 @@ export class UserAgent extends Agent {
         if (this._process)
             super.subscribeToTopics(context);
     }
-    async publishToTopics(output, context) {
+    async publishToTopics(output, options) {
         if (this._process)
-            super.publishToTopics(output, context);
+            super.publishToTopics(output, options);
     }
-    invoke = ((input, context, options) => {
-        if (!context)
+    invoke = ((input, options = {}) => {
+        if (!options.context)
             this.context = this.context.newContext({ reset: true });
-        return super.invoke(input, context ?? this.context, options);
+        return super.invoke(input, { ...options, context: this.context });
     });
-    async process(input, context) {
+    async process(input, options) {
         if (this._process) {
-            return this._process(input, context);
+            return this._process(input, options);
         }
         if (this.activeAgent) {
-            const [output, agent] = await context.invoke(this.activeAgent, input, {
+            const [output, agent] = await options.context.invoke(this.activeAgent, input, {
                 returnActiveAgent: true,
                 streaming: true,
             });
@@ -44,7 +43,7 @@ export class UserAgent extends Agent {
         }
         const publicTopic = typeof this.publishTopic === "function" ? await this.publishTopic(input) : this.publishTopic;
         if (publicTopic?.length) {
-            context.publish(publicTopic, input);
+            options.context.publish(publicTopic, input);
             if (this.subscribeTopic) {
                 return this.subscribe(this.subscribeTopic).then((res) => res.message);
             }
@@ -77,7 +76,7 @@ export class UserAgent extends Agent {
             },
         });
     }
-    checkAgentInvokesUsage(_context) {
+    checkAgentInvokesUsage(_options) {
         // ignore calls usage check for UserAgent
     }
 }

package/lib/esm/aigne/aigne.d.ts

@@ -2,7 +2,7 @@ import { Agent, type AgentResponse, type AgentResponseStream, type Message } fro
 import { ChatModel } from "../agents/chat-model.js";
 import type { UserAgent } from "../agents/user-agent.js";
 import { type LoadOptions } from "../loader/index.js";
-import { AIGNEContext, type InvokeOptions } from "./context.js";
+import { AIGNEContext, type Context, type InvokeOptions, type UserContext } from "./context.js";
 import { type MessagePayload, MessageQueue, type MessageQueueListener, type Unsubscribe } from "./message-queue.js";
 import type { ContextLimits } from "./usage.js";
 /**
@@ -46,7 +46,7 @@ export interface AIGNEOptions {
  * Here's an example of how to use AIGNE with streaming response:
  * {@includeCode ../../test/aigne/aigne.test.ts#example-streaming}
  */
-export declare class AIGNE {
+export declare class AIGNE<U extends UserContext = UserContext> {
     /**
      * Loads an AIGNE instance from a directory containing an aigne.yaml file and agent definitions.
      * This static method provides a convenient way to initialize an AIGNE system from configuration files.
@@ -111,7 +111,7 @@ export declare class AIGNE {
      *
      * @returns A new AIGNEContext instance bound to this AIGNE.
      */
-    newContext(): AIGNEContext;
+    newContext(options?: Partial<Context>): AIGNEContext;
     /**
      * Creates a user agent for consistent interactions with a specified agent.
      * This method allows you to create a wrapper around an agent for repeated invocations.
@@ -134,7 +134,7 @@ export declare class AIGNE {
      * @param options.streaming - Must be false to return a response stream
      * @returns A promise resolving to a tuple containing the agent's response and the final active agent
      */
-    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options: InvokeOptions & {
+    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options: InvokeOptions<U> & {
         returnActiveAgent: true;
         streaming?: false;
     }): Promise<[O, Agent]>;
@@ -148,7 +148,7 @@ export declare class AIGNE {
      * @param options.streaming - Must be true to return a response stream
      * @returns A promise resolving to a tuple containing the agent's response stream and a promise for the final agent
      */
-    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options: InvokeOptions & {
+    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options: InvokeOptions<U> & {
         returnActiveAgent: true;
         streaming: true;
     }): Promise<[AgentResponseStream<O>, Promise<Agent>]>;
@@ -165,7 +165,7 @@ export declare class AIGNE {
      * Here's a simple example of how to invoke an agent:
      * {@includeCode ../../test/aigne/aigne.test.ts#example-simple}
      */
-    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options?: InvokeOptions & {
+    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options?: InvokeOptions<U> & {
         returnActiveAgent?: false;
         streaming?: false;
     }): Promise<O>;
@@ -182,7 +182,7 @@ export declare class AIGNE {
      * Here's an example of how to invoke an agent with streaming response:
      * {@includeCode ../../test/aigne/aigne.test.ts#example-streaming}
      */
-    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options: InvokeOptions & {
+    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message: I | string, options: InvokeOptions<U> & {
         returnActiveAgent?: false;
         streaming: true;
     }): Promise<AgentResponseStream<O>>;
@@ -196,7 +196,7 @@ export declare class AIGNE {
      * @returns Either a UserAgent (when no message provided) or a promise resolving to the agent's response
      * with optional active agent information based on the provided options
      */
-    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message?: I | string, options?: InvokeOptions): UserAgent<I, O> | Promise<AgentResponse<O> | [AgentResponse<O>, Agent]>;
+    invoke<I extends Message, O extends Message>(agent: Agent<I, O>, message?: I | string, options?: InvokeOptions<U>): UserAgent<I, O> | Promise<AgentResponse<O> | [AgentResponse<O>, Agent]>;
     /**
      * Publishes a message to the message queue for inter-agent communication.
      * This method broadcasts a message to all subscribers of the specified topic(s).
@@ -204,12 +204,13 @@ export declare class AIGNE {
      *
      * @param topic - The topic or array of topics to publish the message to
      * @param payload - The message payload to be delivered to subscribers
+     * @param options - Optional configuration parameters for the publish operation
      *
      * @example
      * Here's an example of how to publish a message:
      * {@includeCode ../../test/aigne/aigne.test.ts#example-publish-message}
      */
-    publish(topic: string | string[], payload: Omit<MessagePayload, "context"> | Message | string): void;
+    publish(topic: string | string[], payload: Omit<MessagePayload, "context"> | Message | string, options?: InvokeOptions<U>): void;
     /**
      * Subscribes to receive the next message on a specific topic.
      * This overload returns a Promise that resolves with the next message published to the topic.

package/lib/esm/aigne/aigne.js

@@ -106,8 +106,8 @@ export class AIGNE {
      *
      * @returns A new AIGNEContext instance bound to this AIGNE.
      */
-    newContext() {
-        return new AIGNEContext(this);
+    newContext(options) {
+        return new AIGNEContext(this, options);
     }
     invoke(agent, message, options) {
         return new AIGNEContext(this).invoke(agent, message, options);
@@ -119,13 +119,14 @@ export class AIGNE {
      *
      * @param topic - The topic or array of topics to publish the message to
      * @param payload - The message payload to be delivered to subscribers
+     * @param options - Optional configuration parameters for the publish operation
      *
      * @example
      * Here's an example of how to publish a message:
      * {@includeCode ../../test/aigne/aigne.test.ts#example-publish-message}
      */
-    publish(topic, payload) {
-        return new AIGNEContext(this).publish(topic, payload);
+    publish(topic, payload, options) {
+        return new AIGNEContext(this).publish(topic, payload, options);
     }
     subscribe(topic, listener) {
         return this.messageQueue.subscribe(topic, listener);

package/lib/esm/aigne/context.d.ts

@@ -1,4 +1,4 @@
-import EventEmitter from "node:events";
+import { Emitter } from "strict-event-emitter";
 import { Agent, type AgentInvokeOptions, type AgentProcessAsyncGenerator, type AgentResponse, type AgentResponseStream, type Message } from "../agents/agent.js";
 import type { ChatModel } from "../agents/chat-model.js";
 import { UserAgent } from "../agents/user-agent.js";
@@ -38,7 +38,7 @@ export type ContextEmitEventMap = {
 /**
  * @hidden
  */
-export interface InvokeOptions extends AgentInvokeOptions {
+export interface InvokeOptions<U extends UserContext = UserContext> extends Partial<Omit<AgentInvokeOptions<U>, "context">> {
     returnActiveAgent?: boolean;
     disableTransfer?: boolean;
     sourceAgent?: Agent;
@@ -46,12 +46,18 @@ export interface InvokeOptions extends AgentInvokeOptions {
 /**
  * @hidden
  */
-export interface Context extends TypedEventEmitter<ContextEventMap, ContextEmitEventMap> {
+export interface UserContext extends Record<string, unknown> {
+}
+/**
+ * @hidden
+ */
+export interface Context<U extends UserContext = UserContext> extends TypedEventEmitter<ContextEventMap, ContextEmitEventMap> {
     model?: ChatModel;
     skills?: Agent[];
     usage: ContextUsage;
     limits?: ContextLimits;
     status?: "normal" | "timeout";
+    userContext: U;
     /**
      * Create a user agent to consistently invoke an agent
      * @param agent Agent to invoke
@@ -92,7 +98,7 @@ export interface Context extends TypedEventEmitter<ContextEventMap, ContextEmitE
      * @param topic topic name, or an array of topic names
      * @param payload message to publish
      */
-    publish(topic: string | string[], payload: Omit<MessagePayload, "context"> | Message | string): void;
+    publish(topic: string | string[], payload: Omit<MessagePayload, "context"> | Message | string, options?: InvokeOptions): void;
     subscribe(topic: string | string[], listener?: undefined): Promise<MessagePayload>;
     subscribe(topic: string | string[], listener: MessageQueueListener): Unsubscribe;
     subscribe(topic: string | string[], listener?: MessageQueueListener): Unsubscribe | Promise<MessagePayload>;
@@ -114,15 +120,17 @@ export interface Context extends TypedEventEmitter<ContextEventMap, ContextEmitE
  * @hidden
  */
 export declare class AIGNEContext implements Context {
-    constructor(parent?: ConstructorParameters<typeof AIGNEContextInternal>[0]);
+    constructor(...[parent, ...args]: ConstructorParameters<typeof AIGNEContextShared>);
     parentId?: string;
     id: string;
-    readonly internal: AIGNEContextInternal;
+    readonly internal: AIGNEContextShared;
     get model(): ChatModel | undefined;
     get skills(): Agent<Message, Message>[] | undefined;
     get limits(): ContextLimits | undefined;
     get status(): "normal" | "timeout";
     get usage(): ContextUsage;
+    get userContext(): Context["userContext"];
+    set userContext(userContext: Context["userContext"]);
     newContext({ reset }?: {
         reset?: boolean;
     }): AIGNEContext;
@@ -135,17 +143,18 @@ export declare class AIGNEContext implements Context {
     once<K extends keyof ContextEventMap>(eventName: K, listener: Listener<K, ContextEventMap>): this;
     off<K extends keyof ContextEventMap>(eventName: K, listener: Listener<K, ContextEventMap>): this;
 }
-declare class AIGNEContextInternal {
+declare class AIGNEContextShared {
     private readonly parent?;
     constructor(parent?: (Pick<Context, "model" | "skills" | "limits"> & {
         messageQueue?: MessageQueue;
-    }) | undefined);
+    }) | undefined, overrides?: Partial<Context>);
     readonly messageQueue: MessageQueue;
-    readonly events: EventEmitter<ContextEventMap>;
+    readonly events: Emitter<any>;
     get model(): ChatModel | undefined;
     get skills(): Agent<Message, Message>[] | undefined;
     get limits(): ContextLimits | undefined;
     usage: ContextUsage;
+    userContext: Context["userContext"];
     private abortController;
     private timer?;
     private initTimeout;