Forest Admin - API reference
    Preparing search index...

    Interface ForestServerClient

    Interface for communicating with Forest Admin server. This abstraction allows for easy mocking in tests.

    interface ForestServerClient {
        forestServerUrl: string;
        createActivityLog(
            params: CreateActivityLogParams,
        ): Promise<ActivityLogResponse>;
        createMcpActivityLog(
            params: CreateActivityLogParams,
        ): Promise<ActivityLogResponse>;
        fetchSchema(): Promise<ForestSchemaCollection[]>;
        updateActivityLogStatus(
            params: UpdateActivityLogStatusParams,
        ): Promise<void>;
    }

    Implemented by

    Index

    Properties

    forestServerUrl

    Methods

    createActivityLog createMcpActivityLog fetchSchema updateActivityLogStatus

    Properties

    forestServerUrl: string

    Base URL of the Forest Admin server this client talks to.

    Methods

    • Creates a pending activity log.

      Parameters

      • params: CreateActivityLogParams

      Returns Promise<ActivityLogResponse>

    • Creates a pending activity log using the MCP-dedicated route.

      Parameters

      • params: CreateActivityLogParams

      Returns Promise<ActivityLogResponse>

    • Updates an activity log status.

      Parameters

      • params: UpdateActivityLogStatusParams

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods