orchestrator-client 5.8.3 → 5.9.0

package/dist/index.d.cts

@@ -387,6 +387,21 @@ interface ToolsListResult {
     totalTools: number;
     servers: string[];
 }
+/** The default toolset one workflow (or workflow variant) resolves to. */
+interface WorkflowToolDefaults {
+    workflowId: string;
+    /** Null for every workflow except `vsa`, which is variant-aware. */
+    variant: string | null;
+    tools: string[];
+}
+/**
+ * Default toolsets as returned by `GET /tools/defaults`.
+ *
+ * `vsa` appears once per variant; every other workflow gets a single entry.
+ */
+interface ToolDefaultsResult {
+    workflows: WorkflowToolDefaults[];
+}
 interface ToolCatalogEntry {
     name: string;
     description: string;
@@ -615,7 +630,14 @@ declare class OrchestratorAsync {
         solutionStrategy?: string;
         agentModelId?: string;
         orchestratorModelId?: string;
-        availableTools?: string[];
+        /**
+         * Complete tool list for the task, built-in tools included -- naming a
+         * subset also switches the built-ins off.  Omit (or pass `null`) to get
+         * the workflow's default toolset, which is resolved and stored on the
+         * task at creation time; see {@link getToolDefaults}.  Pass `[]` to run
+         * the agent with no tools at all.
+         */
+        availableTools?: string[] | null;
         attachmentIds?: string[];
         options?: Record<string, boolean>;
     }): Promise<TaskCreateResponse>;
@@ -660,6 +682,11 @@ declare class OrchestratorAsync {
         title?: string;
         agentModelId?: string;
         orchestratorModelId?: string;
+        /**
+         * Complete tool list for the task, built-ins included.  Omit for the
+         * variant's default toolset; pass `[]` to run with no tools.
+         */
+        availableTools?: string[] | null;
         attachmentIds?: string[];
         options?: Record<string, boolean>;
         delegatedToken?: string;
@@ -692,6 +719,14 @@ declare class OrchestratorAsync {
     getMioContext(taskId: string): Promise<MioContext>;
     getMioMemories(taskId: string, includeCommon?: boolean): Promise<MioMemoriesResult>;
     listTools(): Promise<ToolsListResult>;
+    /**
+     * Default toolset every workflow uses when `availableTools` is omitted.
+     *
+     * Resolved against the live catalog, so it only names tools that are
+     * reachable right now -- the same list a task created at this moment
+     * would receive.
+     */
+    getToolDefaults(): Promise<ToolDefaultsResult>;
     getToolCatalog(): Promise<ToolCatalogResult>;
     refreshMCPTools(): Promise<MCPRefreshResult>;
     validateToolCatalog(): Promise<CatalogValidationResult>;
@@ -830,6 +865,7 @@ declare class Orchestrator {
     getMioContext(taskId: string): MioContext;
     getMioMemories(taskId: string, includeCommon?: boolean): MioMemoriesResult;
     listTools(): ToolsListResult;
+    getToolDefaults(): ToolDefaultsResult;
     getToolCatalog(): ToolCatalogResult;
     refreshMCPTools(): MCPRefreshResult;
     validateToolCatalog(): CatalogValidationResult;
@@ -1379,4 +1415,4 @@ declare function deepCamelCase<T>(obj: T): T;
  */
 declare const VERSION = "5.6.0";
 
-export { type ArchivedContent, type AttachmentMeta, type AttachmentUploadResponse, type AuthConfig, type CompactionEvent, type ComponentHealth, type ConfigurationStatus, type ConversationResult, DEFAULT_FLOW_TIMEOUT_MS, EVENT_ERROR_EVENT_RECORDED, EVENT_MESSAGE_ADDED, EVENT_MESSAGE_STREAMING, EVENT_MESSAGE_SUMMARY_GENERATED, EVENT_MESSAGE_TRANSLATION_READY, EVENT_TASK_CREATED, EVENT_TASK_DELETED, EVENT_TASK_INSIGHT_UPDATED, EVENT_TASK_ITERATION_CHANGED, EVENT_TASK_RESULT_UPDATED, EVENT_TASK_STATUS_CHANGED, type ErrorCountResult, type ErrorEvent, type ErrorEventDetail, type ErrorEventListResult, type ErrorPurgeResult, type ErrorStatsResult, type EventHandler, Flow, FlowCancelledError, FlowError, type FlowRunParams, FlowTimeoutError, type HealthDetail, type HealthStatus, type LLMBackendInfo, type LLMBackendStatus, type LLMModelContextInfo, type LLMModelVisionInfo, type LeaderStatus, type LockStatus, type MCPServerInfo, type MCPServerStatus, type MatrixConversationResult, type Message, type MessageDeleteMultipleResult, type MessageTranslation, type MessageTranslationReadyEvent, type MessageTranslationsResult, type MetricSnapshot, type MioContext, type MioMemoriesResult, type MioMemoryItem, Orchestrator, OrchestratorAPIError, OrchestratorAsync, OrchestratorAuthError, type OrchestratorClientOptions, type OrchestratorConfig, OrchestratorConfigError, OrchestratorConnectionError, OrchestratorError, OrchestratorNotFoundError, type Pagination$1 as Pagination, type ReadinessCheck, type ReadinessResult, RealtimeClient, type RealtimeClientOptions, type ReloadServicesResult, type ReloadStatus, type SlotInfo, type SlotsStatus, type SubagentsStatus, type SuccessResponse, type SummaryWorkerStatus, type SystemStatus, type SystemStatusSettings, type TaskCancelResponse, type TaskCreateResponse, type TaskDeleteResult, type TaskDetail, type TaskHandlerCluster, type TaskHandlerReplica, type TaskHandlerStatus, type TaskHandlerStatusLocal, type TaskJournal, type TaskListResult, type TaskOptions, type TaskSummary, type TokenWorkerStatus, type ToolCall, type ToolInfo, type ToolsListResult, VERSION, type VSATaskCreateResponse, type WebSocketClientInfo, type WebSocketStatus, type WorkflowStates, camelToSnake, createInsecureFetch, deepCamelCase, extractJsonFromMessage, loadConfig, setupDefaultClient, snakeToCamel };
+export { type ArchivedContent, type AttachmentMeta, type AttachmentUploadResponse, type AuthConfig, type CompactionEvent, type ComponentHealth, type ConfigurationStatus, type ConversationResult, DEFAULT_FLOW_TIMEOUT_MS, EVENT_ERROR_EVENT_RECORDED, EVENT_MESSAGE_ADDED, EVENT_MESSAGE_STREAMING, EVENT_MESSAGE_SUMMARY_GENERATED, EVENT_MESSAGE_TRANSLATION_READY, EVENT_TASK_CREATED, EVENT_TASK_DELETED, EVENT_TASK_INSIGHT_UPDATED, EVENT_TASK_ITERATION_CHANGED, EVENT_TASK_RESULT_UPDATED, EVENT_TASK_STATUS_CHANGED, type ErrorCountResult, type ErrorEvent, type ErrorEventDetail, type ErrorEventListResult, type ErrorPurgeResult, type ErrorStatsResult, type EventHandler, Flow, FlowCancelledError, FlowError, type FlowRunParams, FlowTimeoutError, type HealthDetail, type HealthStatus, type LLMBackendInfo, type LLMBackendStatus, type LLMModelContextInfo, type LLMModelVisionInfo, type LeaderStatus, type LockStatus, type MCPServerInfo, type MCPServerStatus, type MatrixConversationResult, type Message, type MessageDeleteMultipleResult, type MessageTranslation, type MessageTranslationReadyEvent, type MessageTranslationsResult, type MetricSnapshot, type MioContext, type MioMemoriesResult, type MioMemoryItem, Orchestrator, OrchestratorAPIError, OrchestratorAsync, OrchestratorAuthError, type OrchestratorClientOptions, type OrchestratorConfig, OrchestratorConfigError, OrchestratorConnectionError, OrchestratorError, OrchestratorNotFoundError, type Pagination$1 as Pagination, type ReadinessCheck, type ReadinessResult, RealtimeClient, type RealtimeClientOptions, type ReloadServicesResult, type ReloadStatus, type SlotInfo, type SlotsStatus, type SubagentsStatus, type SuccessResponse, type SummaryWorkerStatus, type SystemStatus, type SystemStatusSettings, type TaskCancelResponse, type TaskCreateResponse, type TaskDeleteResult, type TaskDetail, type TaskHandlerCluster, type TaskHandlerReplica, type TaskHandlerStatus, type TaskHandlerStatusLocal, type TaskJournal, type TaskListResult, type TaskOptions, type TaskSummary, type TokenWorkerStatus, type ToolCall, type ToolDefaultsResult, type ToolInfo, type ToolsListResult, VERSION, type VSATaskCreateResponse, type WebSocketClientInfo, type WebSocketStatus, type WorkflowStates, type WorkflowToolDefaults, camelToSnake, createInsecureFetch, deepCamelCase, extractJsonFromMessage, loadConfig, setupDefaultClient, snakeToCamel };

package/dist/index.d.ts

@@ -387,6 +387,21 @@ interface ToolsListResult {
     totalTools: number;
     servers: string[];
 }
+/** The default toolset one workflow (or workflow variant) resolves to. */
+interface WorkflowToolDefaults {
+    workflowId: string;
+    /** Null for every workflow except `vsa`, which is variant-aware. */
+    variant: string | null;
+    tools: string[];
+}
+/**
+ * Default toolsets as returned by `GET /tools/defaults`.
+ *
+ * `vsa` appears once per variant; every other workflow gets a single entry.
+ */
+interface ToolDefaultsResult {
+    workflows: WorkflowToolDefaults[];
+}
 interface ToolCatalogEntry {
     name: string;
     description: string;
@@ -615,7 +630,14 @@ declare class OrchestratorAsync {
         solutionStrategy?: string;
         agentModelId?: string;
         orchestratorModelId?: string;
-        availableTools?: string[];
+        /**
+         * Complete tool list for the task, built-in tools included -- naming a
+         * subset also switches the built-ins off.  Omit (or pass `null`) to get
+         * the workflow's default toolset, which is resolved and stored on the
+         * task at creation time; see {@link getToolDefaults}.  Pass `[]` to run
+         * the agent with no tools at all.
+         */
+        availableTools?: string[] | null;
         attachmentIds?: string[];
         options?: Record<string, boolean>;
     }): Promise<TaskCreateResponse>;
@@ -660,6 +682,11 @@ declare class OrchestratorAsync {
         title?: string;
         agentModelId?: string;
         orchestratorModelId?: string;
+        /**
+         * Complete tool list for the task, built-ins included.  Omit for the
+         * variant's default toolset; pass `[]` to run with no tools.
+         */
+        availableTools?: string[] | null;
         attachmentIds?: string[];
         options?: Record<string, boolean>;
         delegatedToken?: string;
@@ -692,6 +719,14 @@ declare class OrchestratorAsync {
     getMioContext(taskId: string): Promise<MioContext>;
     getMioMemories(taskId: string, includeCommon?: boolean): Promise<MioMemoriesResult>;
     listTools(): Promise<ToolsListResult>;
+    /**
+     * Default toolset every workflow uses when `availableTools` is omitted.
+     *
+     * Resolved against the live catalog, so it only names tools that are
+     * reachable right now -- the same list a task created at this moment
+     * would receive.
+     */
+    getToolDefaults(): Promise<ToolDefaultsResult>;
     getToolCatalog(): Promise<ToolCatalogResult>;
     refreshMCPTools(): Promise<MCPRefreshResult>;
     validateToolCatalog(): Promise<CatalogValidationResult>;
@@ -830,6 +865,7 @@ declare class Orchestrator {
     getMioContext(taskId: string): MioContext;
     getMioMemories(taskId: string, includeCommon?: boolean): MioMemoriesResult;
     listTools(): ToolsListResult;
+    getToolDefaults(): ToolDefaultsResult;
     getToolCatalog(): ToolCatalogResult;
     refreshMCPTools(): MCPRefreshResult;
     validateToolCatalog(): CatalogValidationResult;
@@ -1379,4 +1415,4 @@ declare function deepCamelCase<T>(obj: T): T;
  */
 declare const VERSION = "5.6.0";
 
-export { type ArchivedContent, type AttachmentMeta, type AttachmentUploadResponse, type AuthConfig, type CompactionEvent, type ComponentHealth, type ConfigurationStatus, type ConversationResult, DEFAULT_FLOW_TIMEOUT_MS, EVENT_ERROR_EVENT_RECORDED, EVENT_MESSAGE_ADDED, EVENT_MESSAGE_STREAMING, EVENT_MESSAGE_SUMMARY_GENERATED, EVENT_MESSAGE_TRANSLATION_READY, EVENT_TASK_CREATED, EVENT_TASK_DELETED, EVENT_TASK_INSIGHT_UPDATED, EVENT_TASK_ITERATION_CHANGED, EVENT_TASK_RESULT_UPDATED, EVENT_TASK_STATUS_CHANGED, type ErrorCountResult, type ErrorEvent, type ErrorEventDetail, type ErrorEventListResult, type ErrorPurgeResult, type ErrorStatsResult, type EventHandler, Flow, FlowCancelledError, FlowError, type FlowRunParams, FlowTimeoutError, type HealthDetail, type HealthStatus, type LLMBackendInfo, type LLMBackendStatus, type LLMModelContextInfo, type LLMModelVisionInfo, type LeaderStatus, type LockStatus, type MCPServerInfo, type MCPServerStatus, type MatrixConversationResult, type Message, type MessageDeleteMultipleResult, type MessageTranslation, type MessageTranslationReadyEvent, type MessageTranslationsResult, type MetricSnapshot, type MioContext, type MioMemoriesResult, type MioMemoryItem, Orchestrator, OrchestratorAPIError, OrchestratorAsync, OrchestratorAuthError, type OrchestratorClientOptions, type OrchestratorConfig, OrchestratorConfigError, OrchestratorConnectionError, OrchestratorError, OrchestratorNotFoundError, type Pagination$1 as Pagination, type ReadinessCheck, type ReadinessResult, RealtimeClient, type RealtimeClientOptions, type ReloadServicesResult, type ReloadStatus, type SlotInfo, type SlotsStatus, type SubagentsStatus, type SuccessResponse, type SummaryWorkerStatus, type SystemStatus, type SystemStatusSettings, type TaskCancelResponse, type TaskCreateResponse, type TaskDeleteResult, type TaskDetail, type TaskHandlerCluster, type TaskHandlerReplica, type TaskHandlerStatus, type TaskHandlerStatusLocal, type TaskJournal, type TaskListResult, type TaskOptions, type TaskSummary, type TokenWorkerStatus, type ToolCall, type ToolInfo, type ToolsListResult, VERSION, type VSATaskCreateResponse, type WebSocketClientInfo, type WebSocketStatus, type WorkflowStates, camelToSnake, createInsecureFetch, deepCamelCase, extractJsonFromMessage, loadConfig, setupDefaultClient, snakeToCamel };
+export { type ArchivedContent, type AttachmentMeta, type AttachmentUploadResponse, type AuthConfig, type CompactionEvent, type ComponentHealth, type ConfigurationStatus, type ConversationResult, DEFAULT_FLOW_TIMEOUT_MS, EVENT_ERROR_EVENT_RECORDED, EVENT_MESSAGE_ADDED, EVENT_MESSAGE_STREAMING, EVENT_MESSAGE_SUMMARY_GENERATED, EVENT_MESSAGE_TRANSLATION_READY, EVENT_TASK_CREATED, EVENT_TASK_DELETED, EVENT_TASK_INSIGHT_UPDATED, EVENT_TASK_ITERATION_CHANGED, EVENT_TASK_RESULT_UPDATED, EVENT_TASK_STATUS_CHANGED, type ErrorCountResult, type ErrorEvent, type ErrorEventDetail, type ErrorEventListResult, type ErrorPurgeResult, type ErrorStatsResult, type EventHandler, Flow, FlowCancelledError, FlowError, type FlowRunParams, FlowTimeoutError, type HealthDetail, type HealthStatus, type LLMBackendInfo, type LLMBackendStatus, type LLMModelContextInfo, type LLMModelVisionInfo, type LeaderStatus, type LockStatus, type MCPServerInfo, type MCPServerStatus, type MatrixConversationResult, type Message, type MessageDeleteMultipleResult, type MessageTranslation, type MessageTranslationReadyEvent, type MessageTranslationsResult, type MetricSnapshot, type MioContext, type MioMemoriesResult, type MioMemoryItem, Orchestrator, OrchestratorAPIError, OrchestratorAsync, OrchestratorAuthError, type OrchestratorClientOptions, type OrchestratorConfig, OrchestratorConfigError, OrchestratorConnectionError, OrchestratorError, OrchestratorNotFoundError, type Pagination$1 as Pagination, type ReadinessCheck, type ReadinessResult, RealtimeClient, type RealtimeClientOptions, type ReloadServicesResult, type ReloadStatus, type SlotInfo, type SlotsStatus, type SubagentsStatus, type SuccessResponse, type SummaryWorkerStatus, type SystemStatus, type SystemStatusSettings, type TaskCancelResponse, type TaskCreateResponse, type TaskDeleteResult, type TaskDetail, type TaskHandlerCluster, type TaskHandlerReplica, type TaskHandlerStatus, type TaskHandlerStatusLocal, type TaskJournal, type TaskListResult, type TaskOptions, type TaskSummary, type TokenWorkerStatus, type ToolCall, type ToolDefaultsResult, type ToolInfo, type ToolsListResult, VERSION, type VSATaskCreateResponse, type WebSocketClientInfo, type WebSocketStatus, type WorkflowStates, type WorkflowToolDefaults, camelToSnake, createInsecureFetch, deepCamelCase, extractJsonFromMessage, loadConfig, setupDefaultClient, snakeToCamel };

package/dist/index.js

@@ -695,6 +695,7 @@ var OrchestratorAsync = class {
       title: params.title,
       agent_model_id: params.agentModelId,
       orchestrator_model_id: params.orchestratorModelId,
+      available_tools: params.availableTools,
       attachment_ids: params.attachmentIds,
       options: params.options
     };
@@ -891,6 +892,25 @@ var OrchestratorAsync = class {
       servers: data.servers ?? []
     };
   }
+  /**
+   * Default toolset every workflow uses when `availableTools` is omitted.
+   *
+   * Resolved against the live catalog, so it only names tools that are
+   * reachable right now -- the same list a task created at this moment
+   * would receive.
+   */
+  async getToolDefaults() {
+    const data = await this._get("/tools/defaults");
+    return {
+      workflows: (data.workflows ?? []).map(
+        (w) => ({
+          workflowId: w.workflowId ?? w.workflow_id ?? "",
+          variant: w.variant ?? null,
+          tools: w.tools ?? []
+        })
+      )
+    };
+  }
   async getToolCatalog() {
     return this._get("/tools/catalog");
   }
@@ -1489,6 +1509,9 @@ var Orchestrator = class {
   listTools() {
     return runSync(this._async.listTools());
   }
+  getToolDefaults() {
+    return runSync(this._async.getToolDefaults());
+  }
   getToolCatalog() {
     return runSync(this._async.getToolCatalog());
   }