Class AgentClientSession

Manages a client session connected to an MJ agent.

Handles bidirectional communication via GraphQL:

Subscribes to ClientToolRequest notifications for tool invocation
Sends tool responses via RespondToClientToolRequest mutation
Sends enriched tool definitions via UpdateClientToolDefinitions mutation
Wraps GraphQLAIClient for agent execution (RunAgent, RunAgentFromConversationDetail)

All events are exposed as RxJS observables for framework-agnostic reactive consumption.

Example

const session = new AgentClientSession();
session.RegisterTool({
    Name: 'NavigateToRecord',
    Description: 'Open an entity record',
    ParameterSchema: { type: 'object', properties: { EntityName: { type: 'string' } } },
    Handler: async (params) => ({ Success: true, Data: 'navigated' })
});
session.StartSession('session-123');
session.ToolRequested$.subscribe(event => console.log('Tool invoked:', event));

Constructors

constructor

new AgentClientSession(
toolRegistry?: ClientToolRegistry,
provider?: IMetadataProvider,
): AgentClientSession
Parameters
- OptionaltoolRegistry: ClientToolRegistry
  Optional pre-built tool registry. Defaults to a fresh empty registry.
- Optionalprovider: IMetadataProvider
  Optional IMetadataProvider to bind this session to. Pass an explicit provider when your app talks to multiple MJ servers in parallel; otherwise the session falls back to Metadata.Provider (the global default), which is fine for single-server apps.
Returns AgentClientSession
- Defined in AgentClientSession.ts:114

Properties

AgentProgress$

AgentProgress$: Subject<AgentProgress> = ...

Emitted on agent progress updates during RunAgent / RunAgentFromConversationDetail

Error$

Error$: Subject<SessionError> = ...

Emitted when an error occurs during tool execution or communication

SessionActive$

SessionActive$: Subject<boolean> = ...

Emitted when session state changes (true = active, false = stopped)

ToolExecuted$

ToolExecuted$: Subject<ClientToolResultEvent> = ...

Emitted after a tool has been executed (with result)

ToolRequested$

ToolRequested$: Subject<ClientToolRequestEvent> = ...

Emitted when a tool request is received from the server (before execution)

Accessors

IsActive

get IsActive(): boolean
Whether a session is currently active and listening for tool requests

Returns boolean
- Defined in AgentClientSession.ts:136

Provider

get Provider(): IMetadataProvider
The metadata provider this session uses. Falls back to the global Metadata.Provider when no explicit provider was supplied.

Returns IMetadataProvider
- Defined in AgentClientSession.ts:123
set Provider(value: IMetadataProvider): void
Parameters
- value: IMetadataProvider
Returns void
- Defined in AgentClientSession.ts:126

SessionId

get SessionId(): string
The current session ID, or null if no session is active

Returns string
- Defined in AgentClientSession.ts:131

ToolRegistry

get ToolRegistry(): ClientToolRegistry
The underlying tool registry

Returns ClientToolRegistry
- Defined in AgentClientSession.ts:141

Methods

AddClientTool

AddClientTool(
tool: ClientToolMetadata & { Handler: ClientToolHandler },
): Promise<void>
Add a client tool dynamically at runtime. Registers the handler locally and notifies the server.
Parameters
- tool: ClientToolMetadata & { Handler: ClientToolHandler }
Returns Promise<void>
- Defined in AgentClientSession.ts:217

DecorateAndSendTools

DecorateAndSendTools(baseTools: ClientToolMetadata[]): Promise<void>
Decorate base tools with runtime context and send definitions to the server.
Parameters
- baseTools: ClientToolMetadata[]
Returns Promise<void>
- Defined in AgentClientSession.ts:202

Dispose

Dispose(): void
Dispose the session: stop listening, complete all observables, and clear state. Call this when the session is no longer needed to prevent memory leaks.

Returns void
- Defined in AgentClientSession.ts:453

GetRegisteredTools

GetRegisteredTools(): ClientToolDefinition[]
Get all registered tool definitions.

Returns ClientToolDefinition[]
- Defined in AgentClientSession.ts:176

RegisterTool

RegisterTool(
    tool: {
        Description: string;
        Handler: ClientToolHandler;
        Name: string;
        ParameterSchema: Record<string, unknown>;
    },
): void
Register a client-side tool. The consuming application calls this to make tools available for server-side agents to invoke. Re-registration is allowed (existing tool is replaced).
Parameters
- tool: {
      Description: string;
      Handler: ClientToolHandler;
      Name: string;
      ParameterSchema: Record<string, unknown>;
  }
Returns void
- Defined in AgentClientSession.ts:154

RegisterToolDecorator

RegisterToolDecorator(toolName: string, decorator: ClientToolDecorator): void
Register a decorator that enriches a metadata-driven tool with runtime context.
Parameters
- toolName: string
- decorator: ClientToolDecorator
Returns void
- Defined in AgentClientSession.ts:187

RemoveClientTool

RemoveClientTool(toolName: string): Promise<void>
Remove a client tool at runtime.
Parameters
- toolName: string
Returns Promise<void>
- Defined in AgentClientSession.ts:233

RunAgent

RunAgent(params: RunAgentParams): Promise<RunAgentResult>
Run an AI agent. Wraps GraphQLAIClient.RunAIAgent() with a simplified API.
Parameters
- params: RunAgentParams
  Parameters for the agent run
Returns Promise<RunAgentResult>
The agent execution result
- Defined in AgentClientSession.ts:314

RunAgentFromConversationDetail

RunAgentFromConversationDetail(
params: RunAgentFromConversationDetailParams,
): Promise<RunAgentResult>
Run an AI agent from an existing conversation detail. This is the optimized path that loads conversation history server-side. Wraps GraphQLAIClient.RunAIAgentFromConversationDetail().
Parameters
- params: RunAgentFromConversationDetailParams
  Parameters for the agent run
Returns Promise<RunAgentResult>
The agent execution result
- Defined in AgentClientSession.ts:386

SetDecoratorContext

SetDecoratorContext(context: ClientToolDecoratorContext): void
Set the runtime context that decorators receive. Call this whenever context changes (user navigates, new data loads, etc.)
Parameters
- context: ClientToolDecoratorContext
Returns void
- Defined in AgentClientSession.ts:195

StartSession

StartSession(sessionId: string): void
Start listening for client tool requests for a specific session. Subscribes to the GraphQL ClientToolRequest subscription via the data provider.
Parameters
- sessionId: string
  The agent session ID to listen for
Returns void
- Defined in AgentClientSession.ts:248

StopSession

StopSession(): void
Stop listening for client tool requests and clean up the session.

Returns void
- Defined in AgentClientSession.ts:291

UnregisterTool

UnregisterTool(toolName: string): void
Unregister a client-side tool.
Parameters
- toolName: string
Returns void
- Defined in AgentClientSession.ts:169

Class AgentClientSession

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AgentClientSession

Properties

AgentProgress$

Error$

SessionActive$

ToolExecuted$

ToolRequested$

Accessors

IsActive

Returns boolean

Provider

Returns IMetadataProvider

Parameters

Returns void

SessionId

Returns string

ToolRegistry

Returns ClientToolRegistry

Methods

AddClientTool

Parameters

Returns Promise<void>

DecorateAndSendTools

Parameters

Returns Promise<void>

Dispose

Returns void

GetRegisteredTools

Returns ClientToolDefinition[]

RegisterTool

Parameters

Returns void

RegisterToolDecorator

Parameters

Returns void

RemoveClientTool

Parameters

Returns Promise<void>

RunAgent

Parameters

Returns Promise<RunAgentResult>

RunAgentFromConversationDetail

Parameters

Returns Promise<RunAgentResult>

SetDecoratorContext

Parameters

Returns void

StartSession

Parameters

Returns void

StopSession

Returns void

UnregisterTool

Parameters

Returns void

Settings

On This Page