Skip to main content

IAgentOptions interface

Agent configuration options.

This interface is used to describe the constellation of plugins that this agent will use and provide.

You will use this to attach plugins, to setup overrides for their methods and to explicitly set the methods that this agent instance is allowed to call. This permissioning method is also used for internal calls made by plugin code.

export interface IAgentOptions


authorizedMethods?string[](Optional) The array of method names that will be exposed by the agent
context?Record<string, any>(Optional) The context object that will be available to the plugin methods
overrides?IPluginMethodMap(Optional) The map of plugin methods. Can be used to override methods provided by plugins, or to add additional methods without writing a plugin
plugins?IAgentPlugin[](Optional) The array of agent plugins

(Optional) Flag that enables schema validation for plugin methods.

Defaults to false.