Class ToolContext

constructor

• new ToolContext(
      options: {
          auth?: AuthHandler;
          invocationContext: InvocationContext;
          parameters?: Record<string, any>;
      },
  ): ToolContext

  Constructor for ToolContext

  Parameters

  • options: {
        auth?: AuthHandler;
        invocationContext: InvocationContext;
        parameters?: Record<string, any>;
    }

  Returns ToolContext

Optionalauth

parameters

toolId

toolName

appName

• get appName(): undefined | string

  Returns undefined | string

config

• get config(): RunConfig

  Returns RunConfig

memoryService

• get memoryService(): undefined | BaseMemoryService

  Returns undefined | BaseMemoryService

messages

• get messages(): Message[]

  Returns Message[]

metadata

• get metadata(): Record<string, any>

  Returns Record<string, any>

sessionId

• get sessionId(): string

  Returns string

sessionService

• get sessionService(): undefined | SessionService

  Returns undefined | SessionService

userId

• get userId(): undefined | string

  Returns undefined | string

variables

• get variables(): Map<string, any>

  Returns Map<string, any>

addMessage

• addMessage(message: Message): void

  Parameters

  • message: Message

  Returns void

getParameter

• getParameter<T>(name: string, defaultValue?: T): undefined | T

  Gets a parameter value

  Type Parameters

  • T

  Parameters

  • name: string
  • OptionaldefaultValue: T

  Returns undefined | T

getVariable

• getVariable<T>(name: string, defaultValue?: T): undefined | T

  Type Parameters

  • T

  Parameters

  • name: string
  • OptionaldefaultValue: T

  Returns undefined | T

loadSession

• loadSession(): Promise<undefined | Session>

  Returns Promise<undefined | Session>

saveSession

• saveSession(): Promise<undefined | Session>

  Returns Promise<undefined | Session>

searchMemory

• searchMemory(
      query: string,
      options?: SearchMemoryOptions,
  ): Promise<SearchMemoryResponse>

  Parameters

  • query: string
  • Optionaloptions: SearchMemoryOptions

  Returns Promise<SearchMemoryResponse>

setParameter

• setParameter(name: string, value: any): void

  Sets a parameter value

  Parameters

  • name: string
  • value: any

  Returns void

setVariable

• setVariable(name: string, value: any): void

  Parameters

  • name: string
  • value: any

  Returns void