ART Framework API Docs
    Preparing search index...

    Interface ArtInstanceConfig

    Configuration for creating an ART instance.

    ArtInstanceConfig

    interface ArtInstanceConfig {
        a2aConfig?: { callbackUrl?: string; discoveryEndpoint?: string };
        agentCore?: new (dependencies: any) => IAgentCore;
        authConfig?: {
            enabled?: boolean;
            strategies?: { id: string; strategy: any }[];
        };
        execution?: ExecutionConfig;
        logger?: { level?: LogLevel };
        mcpConfig?: McpManagerConfig;
        persona?: AgentPersona;
        providers: ProviderManagerConfig;
        stateSavingStrategy?: StateSavingStrategy;
        storage:
            | StorageAdapter
            | {
                dbName?: string;
                objectStores?: any[];
                type: "memory"
                | "indexedDB";
                version?: number;
            };
        tools?: IToolExecutor[];
    }
    Index

    Properties

    a2aConfig? agentCore? authConfig? execution? logger? mcpConfig? persona? providers stateSavingStrategy? storage tools?

    Properties

    a2aConfig?: { callbackUrl?: string; discoveryEndpoint?: string }

    Optional: Configuration for A2A services.

    Type declaration

    • OptionalcallbackUrl?: string

      The callback URL for receiving A2A task updates.

    • OptionaldiscoveryEndpoint?: string

      The endpoint for discovering A2A agents.

    agentCore?: new (dependencies: any) => IAgentCore

    The agent core implementation class to use. Defaults to PESAgent if not provided.

    MyCustomAgentClass
    authConfig?: { enabled?: boolean; strategies?: { id: string; strategy: any }[] }

    Optional configuration for authentication strategies. Used for secure connections to external services and MCP servers.

    Type declaration

    • Optionalenabled?: boolean

      Whether to enable authentication manager. Defaults to false.

    • Optionalstrategies?: { id: string; strategy: any }[]

      Pre-configured authentication strategies to register at startup.

    execution?: ExecutionConfig

    Optional: Configuration for execution phase behavior (TAEF parameters).

    logger?: { level?: LogLevel }

    Optional configuration for the framework's logger.

    Type declaration

    • Optionallevel?: LogLevel

      Minimum log level to output. Defaults to 'info'.

    mcpConfig?: McpManagerConfig

    Optional configuration for MCP (Model Context Protocol) manager. Enables connection to external MCP servers for dynamic tool loading.

    persona?: AgentPersona

    Optional: Defines the default identity and high-level guidance for the agent. This can be overridden at the thread or call level.

    providers: ProviderManagerConfig

    Configuration for the ProviderManager, defining available LLM provider adapters.

    stateSavingStrategy?: StateSavingStrategy

    Defines the strategy for saving AgentState. Defaults to 'explicit'.

    • 'explicit': AgentState is only saved when StateManager.setAgentState() is explicitly called by the agent. StateManager.saveStateIfModified() will be a no-op for AgentState persistence.
    • 'implicit': AgentState is loaded by StateManager.loadThreadContext(). If modified by the agent, StateManager.saveStateIfModified() will attempt to automatically persist these changes. StateManager.setAgentState() will still work for explicit saves in this mode.
    storage:
        | StorageAdapter
        | {
            dbName?: string;
            objectStores?: any[];
            type: "memory"
            | "indexedDB";
            version?: number;
        }

    Configuration for the storage adapter. Can be a pre-configured StorageAdapter instance, or an object specifying the type and options for a built-in adapter.

    { type: 'indexedDB', dbName: 'MyArtDB' }
    tools?: IToolExecutor[]

    An optional array of tool executor instances to register at initialization.

    Settings

    Member Visibility

    On This Page

    Properties