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[]>;
        getMcpWorkflowById(
            params: GetMcpWorkflowByIdParams,
        ): Promise<McpWorkflowLookup>;
        getMcpWorkflowRun(
            params: GetMcpWorkflowRunParams,
        ): Promise<HydratedWorkflowRun>;
        listMcpEnabledWorkflows(
            params: ListMcpWorkflowsParams,
        ): Promise<McpWorkflow[]>;
        triggerMcpWorkflow(
            params: TriggerMcpWorkflowParams,
        ): Promise<WorkflowRunTriggerResult>;
        updateActivityLogStatus(
            params: UpdateActivityLogStatusParams,
        ): Promise<void>;
    }

    Implemented by

    Index

    Properties

    forestServerUrl

    Methods

    createActivityLog createMcpActivityLog fetchSchema getMcpWorkflowById getMcpWorkflowRun listMcpEnabledWorkflows triggerMcpWorkflow 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>

    • Resolves a single workflow by id (name, collection, mcpEnabled), scoped to the caller.

      Parameters

      • params: GetMcpWorkflowByIdParams

      Returns Promise<McpWorkflowLookup>

    • Reads the full hydrated workflow run, scoped to the caller.

      Parameters

      • params: GetMcpWorkflowRunParams

      Returns Promise<HydratedWorkflowRun>

    • Lists the MCP-enabled workflows the caller can access in a rendering.

      Parameters

      • params: ListMcpWorkflowsParams

      Returns Promise<McpWorkflow[]>

    • Starts a run of an MCP-enabled workflow on a record and returns its runId (async).

      Parameters

      • params: TriggerMcpWorkflowParams

      Returns Promise<WorkflowRunTriggerResult>

    • Updates an activity log status.

      Parameters

      • params: UpdateActivityLogStatusParams

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods