Class ForestServerClientImpl

constructor

• new ForestServerClientImpl(
      schemaService: SchemaServiceInterface,
      activityLogsService: ActivityLogsServiceInterface,
      workflowsService: WorkflowsServiceInterface,
      forestServerUrl: string,
  ): ForestServerClientImpl

  Parameters

  • schemaService: SchemaServiceInterface
  • activityLogsService: ActivityLogsServiceInterface
  • workflowsService: WorkflowsServiceInterface
  • forestServerUrl: string

  Returns ForestServerClientImpl

ReadonlyforestServerUrl

createActivityLog

• createActivityLog(params: CreateActivityLogParams): Promise<ActivityLogResponse>

  Creates a pending activity log.

  Parameters

  • params: CreateActivityLogParams

  Returns Promise<ActivityLogResponse>

createMcpActivityLog

• createMcpActivityLog(
      params: CreateActivityLogParams,
  ): Promise<ActivityLogResponse>

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

  Parameters

  • params: CreateActivityLogParams

  Returns Promise<ActivityLogResponse>

fetchSchema

• fetchSchema(): Promise<ForestSchemaCollection[]>

  Fetches the Forest Admin schema from the server.

  Returns Promise<ForestSchemaCollection[]>

getMcpWorkflowById

• getMcpWorkflowById(params: GetMcpWorkflowByIdParams): Promise<McpWorkflowLookup>

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

  Parameters

  • params: GetMcpWorkflowByIdParams

  Returns Promise<McpWorkflowLookup>

getMcpWorkflowRun

• getMcpWorkflowRun(params: GetMcpWorkflowRunParams): Promise<HydratedWorkflowRun>

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

  Parameters

  • params: GetMcpWorkflowRunParams

  Returns Promise<HydratedWorkflowRun>

listMcpEnabledWorkflows

• listMcpEnabledWorkflows(params: ListMcpWorkflowsParams): Promise<McpWorkflow[]>

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

  Parameters

  • params: ListMcpWorkflowsParams

  Returns Promise<McpWorkflow[]>

triggerMcpWorkflow

• triggerMcpWorkflow(
      params: TriggerMcpWorkflowParams,
  ): Promise<WorkflowRunTriggerResult>

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

  Parameters

  • params: TriggerMcpWorkflowParams

  Returns Promise<WorkflowRunTriggerResult>

updateActivityLogStatus

• updateActivityLogStatus(params: UpdateActivityLogStatusParams): Promise<void>

  Updates an activity log status.

  Parameters

  • params: UpdateActivityLogStatusParams

  Returns Promise<void>