Interface IAgentSchemaInternal

Interface representing the configuration schema for an agent. Defines the agent's properties, tools, and lifecycle behavior.

interface IAgentSchemaInternal {
    agentName: string;
    callbacks?: Partial<IAgentSchemaInternalCallbacks>;
    completion?: string;
    connectOperator?: (
        clientId: string,
        agentName: string,
    ) => (message: string, next: (answer: string) => void) => DisposeFn$2;
    dependsOn?: string[];
    docDescription?: string;
    keepMessages?: number;
    map?: (
        message: ISwarmMessage,
        clientId: string,
        agentName: string,
    ) => ISwarmMessage<object> | Promise<ISwarmMessage<object>>;
    mapToolCalls?: (
        tool: IToolCall[],
        clientId: string,
        agentName: string,
    ) => IToolCall[] | Promise<IToolCall[]>;
    maxToolCalls?: number;
    mcp?: string[];
    operator?: boolean;
    prompt?:
        | string
        | (clientId: string, agentName: string) => string | Promise<string>;
    states?: string[];
    storages?: string[];
    system?: string[];
    systemDynamic?: (
        clientId: string,
        agentName: string,
    ) => string[] | Promise<string[]>;
    systemStatic?: string[];
    tools?: string[];
    transform?: (
        input: string,
        clientId: string,
        agentName: string,
    ) => string | Promise<string>;
    validate?: (output: string) => Promise<string>;
}

Properties

agentName callbacks? completion? connectOperator? dependsOn? docDescription? keepMessages? map? mapToolCalls? maxToolCalls? mcp? operator? prompt? states? storages? system? systemDynamic? systemStatic? tools? transform? validate?

Properties

agentName

agentName: string

The unique name of the agent within the swarm.

Optionalcallbacks

callbacks?: Partial<IAgentSchemaInternalCallbacks>

Optional lifecycle callbacks for the agent, allowing customization of execution flow.

Optionalcompletion

completion?: string

The name of the completion mechanism used by the agent. REQUIRED WHEN AGENT IS NOT OPERATOR

OptionalconnectOperator

connectOperator?: (
    clientId: string,
    agentName: string,
) => (message: string, next: (answer: string) => void) => DisposeFn$2

Operator connection function to passthrough the chat into operator dashboard

OptionaldependsOn

dependsOn?: string[]

Optional array of agent names this agent depends on for transitions (e.g., via changeToAgent).

OptionaldocDescription

docDescription?: string

Optional description for documentation purposes, aiding in agent usage understanding.

OptionalkeepMessages

keepMessages?: number

Optional maximum number of messages to maintain context size

Optionalmap

map?: (
    message: ISwarmMessage,
    clientId: string,
    agentName: string,
) => ISwarmMessage<object> | Promise<ISwarmMessage<object>>

Optional function to map assistant messages, e.g., converting JSON to tool calls for specific models.

OptionalmapToolCalls

mapToolCalls?: (
    tool: IToolCall[],
    clientId: string,
    agentName: string,
) => IToolCall[] | Promise<IToolCall[]>

Optional function to filter or modify tool calls before execution.

OptionalmaxToolCalls

maxToolCalls?: number

Optional maximum number of tool calls allowed per completion cycle.

Optionalmcp

mcp?: string[]

Optional array of mcp names managed by the agent

Optionaloperator

operator?: boolean

Flag means the operator is going to chat with customer on another side

Optionalprompt

prompt?:
    | string
    | (clientId: string, agentName: string) => string | Promise<string>

The primary prompt guiding the agent's behavior.

Optionalstates

states?: string[]

Optional array of state names managed by the agent.

Optionalstorages

storages?: string[]

Optional array of storage names utilized by the agent.

Optionalsystem

system?: string[]

Optional array of system prompts, typically used for tool-calling protocols.

OptionalsystemDynamic

systemDynamic?: (
    clientId: string,
    agentName: string,
) => string[] | Promise<string[]>

Optional dynamic array of system prompts from the callback

OptionalsystemStatic

systemStatic?: string[]

Optional array of system prompts, alias for system

Optionaltools

tools?: string[]

Optional array of tool names available to the agent.

Optionaltransform

transform?: (
    input: string,
    clientId: string,
    agentName: string,
) => string | Promise<string>

Optional function to transform the model's output before further processing.

Optionalvalidate

validate?: (output: string) => Promise<string>

Optional function to validate the agent's output before finalization.

Settings

Member Visibility

On This Page

Properties