ibm-watsonx-orchestrate 1.6.2__py3-none-any.whl → 1.7.0b1__py3-none-any.whl

ibm_watsonx_orchestrate/agent_builder/tools/types.py

@@ -2,6 +2,7 @@ from enum import Enum
 from typing import List, Any, Dict, Literal, Optional, Union
 
 from pydantic import BaseModel, model_validator, ConfigDict, Field, AliasChoices
+from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 
 
 class ToolPermission(str, Enum):
@@ -74,19 +75,19 @@ class OpenApiSecurityScheme(BaseModel):
     @model_validator(mode='after')
     def validate_security_scheme(self) -> 'OpenApiSecurityScheme':
         if self.type == 'http' and self.scheme is None:
-            raise ValueError("'scheme' is required when type is 'http'")
+            raise BadRequest("'scheme' is required when type is 'http'")
 
         if self.type == 'oauth2' and self.flows is None:
-            raise ValueError("'flows' is required when type is 'oauth2'")
+            raise BadRequest("'flows' is required when type is 'oauth2'")
 
         if self.type == 'openIdConnect' and self.open_id_connect_url is None:
-            raise ValueError("'open_id_connect_url' is required when type is 'openIdConnect'")
+            raise BadRequest("'open_id_connect_url' is required when type is 'openIdConnect'")
 
         if self.type == 'apiKey':
             if self.name is None:
-                raise ValueError("'name' is required when type is 'apiKey'")
+                raise BadRequest("'name' is required when type is 'apiKey'")
             if self.in_field is None:
-                raise ValueError("'in_field' is required when type is 'apiKey'")
+                raise BadRequest("'in_field' is required when type is 'apiKey'")
 
         return self
 
@@ -111,7 +112,7 @@ class OpenApiToolBinding(BaseModel):
     @model_validator(mode='after')
     def validate_openapi_tool_binding(self):
         if len(self.servers) != 1:
-            raise ValueError("OpenAPI definition must include exactly one server")
+            raise BadRequest("OpenAPI definition must include exactly one server")
         return self
 
 
@@ -129,7 +130,7 @@ class WxFlowsToolBinding(BaseModel):
     @model_validator(mode='after')
     def validate_security_scheme(self) -> 'WxFlowsToolBinding':
         if self.security.type != 'apiKey':
-            raise ValueError("'security' scheme must be of type 'apiKey'")
+            raise BadRequest("'security' scheme must be of type 'apiKey'")
         return self
 
 
@@ -173,9 +174,9 @@ class ToolBinding(BaseModel):
             self.flow is not None
         ]
         if sum(bindings) == 0:
-            raise ValueError("One binding must be set")
+            raise BadRequest("One binding must be set")
         if sum(bindings) > 1:
-            raise ValueError("Only one binding can be set")
+            raise BadRequest("Only one binding can be set")
         return self
 
 class ToolSpec(BaseModel):

ibm_watsonx_orchestrate/cli/commands/agents/agents_command.py

@@ -31,6 +31,13 @@ def agent_create(
         str,
         typer.Option("--name", "-n", help="Name of the agent you wish to create"),
     ],
+    description: Annotated[
+        str,
+        typer.Option(
+            "--description",
+            help="Description of the agent",
+        ),
+    ],
     title: Annotated[
         str,
         typer.Option("--title", "-t", help="Title of the agent you wish to create. Only needed for External and Assistant Agents"),
@@ -87,13 +94,6 @@ def agent_create(
         str,
         typer.Option("--app-id", help="Application ID for the agent"),
     ] = None,
-    description: Annotated[
-        str,
-        typer.Option(
-            "--description",
-            help="Description of the agent",
-        ),
-    ] = None,
     llm: Annotated[
         str,
         typer.Option(

ibm_watsonx_orchestrate/cli/commands/agents/agents_controller.py

@@ -29,6 +29,7 @@ from ibm_watsonx_orchestrate.client.agents.agent_client import AgentClient, Agen
 from ibm_watsonx_orchestrate.client.agents.external_agent_client import ExternalAgentClient
 from ibm_watsonx_orchestrate.client.agents.assistant_agent_client import AssistantAgentClient
 from ibm_watsonx_orchestrate.client.tools.tool_client import ToolClient
+from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 from ibm_watsonx_orchestrate.client.connections import get_connections_client
 from ibm_watsonx_orchestrate.client.knowledge_bases.knowledge_base_client import KnowledgeBaseClient
 
@@ -71,7 +72,7 @@ def create_agent_from_spec(file:str, kind:str) -> Agent | ExternalAgent | Assist
         case AgentKind.ASSISTANT:
             agent = AssistantAgent.from_spec(file)
         case _:
-            raise ValueError("'kind' must be either 'native' or 'external'")
+            raise BadRequest("'kind' must be either 'native' or 'external'")
 
     return agent
 
@@ -88,7 +89,7 @@ def parse_file(file: str) -> List[Agent | ExternalAgent | AssistantAgent]:
         agents = import_python_agent(file)
         return agents
     else:
-        raise ValueError("file must end in .json, .yaml, .yml or .py")
+        raise BadRequest("file must end in .json, .yaml, .yml or .py")
 
 def parse_create_native_args(name: str, kind: AgentKind, description: str | None, **args) -> dict:
     agent_details = {
@@ -950,7 +951,7 @@ class AgentsController:
             elif kind == AgentKind.ASSISTANT:
                 client = self.get_assistant_client()
             else:
-                raise ValueError("'kind' must be 'native'")
+                raise BadRequest("'kind' must be 'native'")
 
             draft_agents = client.get_draft_by_name(name)
             if len(draft_agents) > 1:

ibm_watsonx_orchestrate/cli/commands/environment/environment_controller.py

@@ -23,7 +23,7 @@ from ibm_watsonx_orchestrate.cli.config import (
 )
 from ibm_watsonx_orchestrate.client.client import Client
 from ibm_watsonx_orchestrate.client.client_errors import ClientError
-from ibm_watsonx_orchestrate.client.agents.agent_client import AgentClient, ClientAPIException
+from ibm_watsonx_orchestrate.client.knowledge_bases.knowledge_base_client import KnowledgeBaseClient, ClientAPIException
 from ibm_watsonx_orchestrate.client.credentials import Credentials
 from threading import Lock
 from ibm_watsonx_orchestrate.client.utils import is_local_dev, check_token_validity, is_cpd_env
@@ -55,13 +55,13 @@ def _validate_token_functionality(token: str, url: str) -> None:
     '''
     is_cpd = is_cpd_env(url)
     if is_cpd is True:
-        agent_client = AgentClient(base_url=url, api_key=token, is_local=is_local_dev(url), verify=False)
+        knowledge_base_client = KnowledgeBaseClient(base_url=url, api_key=token, is_local=is_local_dev(url), verify=False)
     else:
-        agent_client = AgentClient(base_url=url, api_key=token, is_local=is_local_dev(url))
-    agent_client.api_key = token
+        knowledge_base_client = KnowledgeBaseClient(base_url=url, api_key=token, is_local=is_local_dev(url))
+    knowledge_base_client.api_key = token
 
     try:
-        agent_client.get()
+        knowledge_base_client.get()
     except ClientAPIException as e:
         if e.response.status_code >= 400:
             reason = e.response.reason

ibm_watsonx_orchestrate/cli/commands/environment/types.py

@@ -4,6 +4,8 @@ from enum import Enum
 class EnvironmentAuthType(str, Enum):
     IBM_CLOUD_IAM = 'ibm_iam'
     MCSP = 'mcsp'
+    MCSP_V1 = 'mcsp_v1'
+    MCSP_V2 = 'mcsp_v2'
     CPD = 'cpd'
 
     def __str__(self):

ibm_watsonx_orchestrate/cli/commands/knowledge_bases/knowledge_bases_command.py

@@ -21,24 +21,6 @@ def knowledge_base_import(
     controller = KnowledgeBaseController()
     controller.import_knowledge_base(file=file, app_id=app_id)
 
-@knowledge_bases_app.command(name="patch", help="Patch a knowledge base by uploading documents, or providing an external vector index")
-def knowledge_base_patch(
-    file: Annotated[
-        str,
-        typer.Option("--file", "-f", help="YAML or JSON file with knowledge base definition"),
-    ],
-    name: Annotated[
-        str,
-        typer.Option("--name", "-n", help="Name of the knowledge base you wish to update"),
-    ]=None,
-    id: Annotated[
-        str,
-        typer.Option("--id", "-i", help="ID of the knowledge base you wish to update"),
-    ]=None
-):
-    controller = KnowledgeBaseController()
-    controller.update_knowledge_base(id=id, name=name, file=file)
-
 
 @knowledge_bases_app.command(name="list", help="List all knowledge bases")
 def list_knowledge_bases(

ibm_watsonx_orchestrate/cli/commands/knowledge_bases/knowledge_bases_controller.py

@@ -8,7 +8,6 @@ import inspect
 from pathlib import Path
 from typing import List
 
-from ibm_watsonx_orchestrate.agent_builder.knowledge_bases.knowledge_base_requests import KnowledgeBaseUpdateRequest
 from ibm_watsonx_orchestrate.agent_builder.knowledge_bases.knowledge_base import KnowledgeBase
 from ibm_watsonx_orchestrate.client.knowledge_bases.knowledge_base_client import KnowledgeBaseClient
 from ibm_watsonx_orchestrate.client.base_api_client import ClientAPIException
@@ -72,11 +71,20 @@ class KnowledgeBaseController:
         client = self.get_client()
 
         knowledge_bases = parse_file(file=file)
+        existing_knowledge_bases = client.get_by_names([kb.name for kb in knowledge_bases])
+        
         for kb in knowledge_bases:
             try:
+                file_dir = "/".join(file.split("/")[:-1])
+
+                existing = list(filter(lambda ex: ex.get('name') == kb.name, existing_knowledge_bases))
+                if len(existing) > 0:
+                    logger.info(f"Existing knowledge base '{kb.name}' found. Updating...")
+                    self.update_knowledge_base(existing[0].get("id"), kb=kb, file_dir=file_dir)
+                    continue
+
                 kb.validate_documents_or_index_exists()
                 if kb.documents:
-                    file_dir = "/".join(file.split("/")[:-1])
                     files = [('files', (get_file_name(file_path), open(get_relative_file_path(file_path, file_dir), 'rb'))) for file_path in kb.documents]
                     
                     kb.prioritize_built_in_index = True
@@ -106,10 +114,7 @@ class KnowledgeBaseController:
                 
                 logger.info(f"Successfully imported knowledge base '{kb.name}'")
             except ClientAPIException as e:
-                if "duplicate key value violates unique constraint" in e.response.text:
-                    logger.error(f"A knowledge base with the name '{kb.name}' already exists. Failed to import knowledge base")
-                else:
-                    logger.error(f"Error importing knowledge base '{kb.name}\n' {e.response.text}")
+                logger.error(f"Error importing knowledge base '{kb.name}\n' {e.response.text}")
     
     def get_id(
         self, id: str, name: str
@@ -131,27 +136,36 @@ class KnowledgeBaseController:
 
 
     def update_knowledge_base(
-        self, id: str, name: str, file: str
+        self, knowledge_base_id: str, kb: KnowledgeBase, file_dir: str
     ) -> None:
-        knowledge_base_id = self.get_id(id, name)
-        update_request = KnowledgeBaseUpdateRequest.from_spec(file=file)
+        filtered_files = []
+        
+        if kb.documents:
+            status = self.get_client().status(knowledge_base_id)
+            existing_docs = [doc.get("metadata", {}).get("original_file_name", "") for doc in status.get("documents", [])]
+            
+            for filepath in kb.documents:
+                filename = get_file_name(filepath)
 
-        if update_request.documents:
-            file_dir = "/".join(file.split("/")[:-1])
-            files = [('files', (get_file_name(file_path), open(get_relative_file_path(file_path, file_dir), 'rb'))) for file_path in update_request.documents]
+                if filename in existing_docs:
+                    logger.warning(f'Document \"{filename}\" already exists in knowledge base, skipping.')
+                else:
+                    filtered_files.append(filepath)
+
+        if filtered_files:
+            files = [('files', (get_file_name(file_path), open(get_relative_file_path(file_path, file_dir), 'rb'))) for file_path in filtered_files]
             
-            update_request.prioritize_built_in_index = True
-            payload = update_request.model_dump(exclude_none=True);
+            kb.prioritize_built_in_index = True
+            payload = kb.model_dump(exclude_none=True);
             payload.pop('documents');
 
             self.get_client().update_with_documents(knowledge_base_id, payload=payload, files=files)
         else:
-            if update_request.conversational_search_tool and update_request.conversational_search_tool.index_config:
-                update_request.prioritize_built_in_index = False
-            self.get_client().update(knowledge_base_id, update_request.model_dump(exclude_none=True))
+            if kb.conversational_search_tool and kb.conversational_search_tool.index_config:
+                kb.prioritize_built_in_index = False
+            self.get_client().update(knowledge_base_id, kb.model_dump(exclude_none=True))
 
-        logEnding = f"with ID '{id}'" if id else f"'{name}'"
-        logger.info(f"Successfully updated knowledge base {logEnding}")
+        logger.info(f"Knowledge base '{kb.name}' updated successfully")
 
 
     def knowledge_base_status( self, id: str, name: str) -> None:

ibm_watsonx_orchestrate/cli/commands/models/models_command.py

@@ -149,7 +149,7 @@ def models_policy_add(
         retry_attempts: Annotated[
             int,
             typer.Option('--retry-attempts', help='The number of attempts to retry'),
-        ],
+        ] = None,
         strategy_on_code: Annotated[
             List[int],
             typer.Option('--strategy-on-code', help='The http status to consider invoking the strategy'),

ibm_watsonx_orchestrate/cli/commands/server/server_command.py

@@ -33,6 +33,29 @@ logger = logging.getLogger(__name__)
 server_app = typer.Typer(no_args_is_help=True)
 
 
+_ALWAYS_UNSET: set[str] = {
+    "WO_API_KEY",
+    "WO_INSTANCE",
+    "DOCKER_IAM_KEY",
+    "WO_DEVELOPER_EDITION_SOURCE",
+    "WATSONX_SPACE_ID",
+    "WATSONX_APIKEY",
+    "WO_USERNAME",
+    "WO_PASSWORD",
+}
+  
+def define_saas_wdu_runtime(value: str = "none") -> None:
+    cfg = Config()
+
+    current_config_file_values = cfg.get(USER_ENV_CACHE_HEADER)
+    current_config_file_values["SAAS_WDU_RUNTIME"] = value
+
+    cfg.save(
+        {
+            USER_ENV_CACHE_HEADER: current_config_file_values
+        }
+    )
+
 def ensure_docker_installed() -> None:
     try:
         subprocess.run(["docker", "--version"], check=True, capture_output=True)
@@ -261,6 +284,13 @@ def _check_exclusive_observibility(langfuse_enabled: bool, ibm_tele_enabled: boo
         return False
     return True
 
+def _prepare_clean_env(env_file: Path) -> None:
+    """Remove env vars so terminal definitions don't override"""
+    keys_from_file = set(dotenv_values(str(env_file)).keys())
+    keys_to_unset = keys_from_file | _ALWAYS_UNSET
+    for key in keys_to_unset:
+        os.environ.pop(key, None)
+
 def write_merged_env_file(merged_env: dict) -> Path:
     tmp = tempfile.NamedTemporaryFile(mode="w", delete=False, suffix=".env")
     with tmp:
@@ -293,7 +323,8 @@ NON_SECRET_ENV_ITEMS = {
     "WO_INSTANCE",
     "USE_SAAS_ML_TOOLS_RUNTIME",
     "AUTHORIZATION_URL",
-    "OPENSOURCE_REGISTRY_PROXY"
+    "OPENSOURCE_REGISTRY_PROXY",
+    "SAAS_WDU_RUNTIME"
 }
 def persist_user_env(env: dict, include_secrets: bool = False) -> None:
     if include_secrets:
@@ -313,10 +344,10 @@ def get_persisted_user_env() -> dict | None:
     user_env = cfg.get(USER_ENV_CACHE_HEADER) if cfg.get(USER_ENV_CACHE_HEADER) else None
     return user_env
 
-
-def run_compose_lite(final_env_file: Path, experimental_with_langfuse=False, experimental_with_ibm_telemetry=False) -> None:
+def run_compose_lite(final_env_file: Path, experimental_with_langfuse=False, experimental_with_ibm_telemetry=False, with_doc_processing=False) -> None:
     compose_path = get_compose_file()
     compose_command = ensure_docker_compose_installed()
+    _prepare_clean_env(final_env_file)  
     db_tag = read_env_file(final_env_file).get('DBTAG', None)
     logger.info(f"Detected architecture: {platform.machine()}, using DBTAG: {db_tag}")
 
@@ -341,19 +372,17 @@ def run_compose_lite(final_env_file: Path, experimental_with_langfuse=False, exp
 
 
     # Step 2: Start all remaining services (except DB)
+    profiles = []
     if experimental_with_langfuse:
-        command = compose_command + [
-            '--profile',
-            'langfuse'
-        ]
-    elif experimental_with_ibm_telemetry:
-        command = compose_command + [
-            '--profile',
-            'ibm-telemetry'
-        ]
-    else:
-        command = compose_command
+        profiles.append("langfuse")
+    if experimental_with_ibm_telemetry:
+        profiles.append("ibm-telemetry")
+    if with_doc_processing:
+        profiles.append("docproc")
 
+    command = compose_command[:]
+    for profile in profiles:
+        command += ["--profile", profile]
 
     command += [
         "-f", str(compose_path),
@@ -431,6 +460,7 @@ def wait_for_wxo_ui_health_check(timeout_seconds=45, interval_seconds=2):
 def run_compose_lite_ui(user_env_file: Path) -> bool:
     compose_path = get_compose_file()
     compose_command = ensure_docker_compose_installed()
+    _prepare_clean_env(user_env_file)  
     ensure_docker_installed()
 
     default_env = read_env_file(get_default_env_file())
@@ -525,6 +555,7 @@ def run_compose_lite_ui(user_env_file: Path) -> bool:
 def run_compose_lite_down_ui(user_env_file: Path, is_reset: bool = False) -> None:
     compose_path = get_compose_file()
     compose_command = ensure_docker_compose_installed()
+    _prepare_clean_env(user_env_file)  
 
 
     ensure_docker_installed()
@@ -568,6 +599,7 @@ def run_compose_lite_down_ui(user_env_file: Path, is_reset: bool = False) -> Non
 def run_compose_lite_down(final_env_file: Path, is_reset: bool = False) -> None:
     compose_path = get_compose_file()
     compose_command = ensure_docker_compose_installed()
+    _prepare_clean_env(final_env_file)  
 
     command = compose_command + [
         '--profile', '*',
@@ -600,6 +632,7 @@ def run_compose_lite_down(final_env_file: Path, is_reset: bool = False) -> None:
 def run_compose_lite_logs(final_env_file: Path, is_reset: bool = False) -> None:
     compose_path = get_compose_file()
     compose_command = ensure_docker_compose_installed()
+    _prepare_clean_env(final_env_file)  
 
     command = compose_command + [
         "-f", str(compose_path),
@@ -655,63 +688,63 @@ def confirm_accepts_license_agreement(accepts_by_argument: bool):
 def auto_configure_callback_ip(merged_env_dict: dict) -> dict:
     """
     Automatically detect and configure CALLBACK_HOST_URL if it's empty.
-    
+
     Args:
         merged_env_dict: The merged environment dictionary
-        
+
     Returns:
         Updated environment dictionary with CALLBACK_HOST_URL set
     """
     callback_url = merged_env_dict.get('CALLBACK_HOST_URL', '').strip()
-    
+
     # Only auto-configure if CALLBACK_HOST_URL is empty
     if not callback_url:
         logger.info("Auto-detecting local IP address for async tool callbacks...")
-        
+
         system = platform.system()
         ip = None
-        
+
         try:
             if system in ("Linux", "Darwin"):
                 result = subprocess.run(["ifconfig"], capture_output=True, text=True, check=True)
                 lines = result.stdout.splitlines()
-                
+
                 for line in lines:
                     line = line.strip()
                     # Unix ifconfig output format: "inet 192.168.1.100 netmask 0xffffff00 broadcast 192.168.1.255"
                     if line.startswith("inet ") and "127.0.0.1" not in line:
                         candidate_ip = line.split()[1]
                         # Validate IP is not loopback or link-local
-                        if (candidate_ip and 
-                            not candidate_ip.startswith("127.") and 
+                        if (candidate_ip and
+                            not candidate_ip.startswith("127.") and
                             not candidate_ip.startswith("169.254")):
                             ip = candidate_ip
                             break
-            
+
             elif system == "Windows":
                 result = subprocess.run(["ipconfig"], capture_output=True, text=True, check=True)
                 lines = result.stdout.splitlines()
-                
+
                 for line in lines:
                     line = line.strip()
                     # Windows ipconfig output format: "   IPv4 Address. . . . . . . . . . . : 192.168.1.100"
                     if "IPv4 Address" in line and ":" in line:
                         candidate_ip = line.split(":")[-1].strip()
                         # Validate IP is not loopback or link-local
-                        if (candidate_ip and 
-                            not candidate_ip.startswith("127.") and 
+                        if (candidate_ip and
+                            not candidate_ip.startswith("127.") and
                             not candidate_ip.startswith("169.254")):
                             ip = candidate_ip
                             break
-            
+
             else:
                 logger.warning(f"Unsupported platform: {system}")
                 ip = None
-                
+
         except Exception as e:
             logger.debug(f"IP detection failed on {system}: {e}")
             ip = None
-        
+
         if ip:
             callback_url = f"http://{ip}:4321"
             merged_env_dict['CALLBACK_HOST_URL'] = callback_url
@@ -724,7 +757,7 @@ def auto_configure_callback_ip(merged_env_dict: dict) -> dict:
             logger.info("For external tools, consider using ngrok or similar tunneling service.")
     else:
         logger.info(f"Using existing CALLBACK_HOST_URL: {callback_url}")
-    
+
     return merged_env_dict
 
 @server_app.command(name="start")
@@ -755,9 +788,16 @@ def server_start(
         "--accept-terms-and-conditions",
         help="By providing this flag you accept the terms and conditions outlined in the logs on server start."
     ),
+    with_doc_processing: bool = typer.Option(
+        False,
+        '--with-doc-processing', '-d',
+        help='Enable IBM Document Processing to extract information from your business documents. Enabling this activates the Watson Document Understanding service.'
+    ),
 ):
     confirm_accepts_license_agreement(accept_terms_and_conditions)
 
+    define_saas_wdu_runtime()
+    
     if user_env_file and not Path(user_env_file).exists():
         logger.error(f"Error: The specified environment file '{user_env_file}' does not exist.")
         sys.exit(1)
@@ -789,10 +829,14 @@ def server_start(
         logger.error("Please select either langfuse or ibm telemetry for observability not both")
         sys.exit(1)
 
-    # Add LANGFUSE_ENABLED into the merged_env_dict, for tempus to pick up.
+    # Add LANGFUSE_ENABLED and DOCPROC_ENABLED into the merged_env_dict, for tempus to pick up.
     if experimental_with_langfuse:
         merged_env_dict['LANGFUSE_ENABLED'] = 'true'
-        
+
+    if with_doc_processing:
+        merged_env_dict['DOCPROC_ENABLED'] = 'true'
+        define_saas_wdu_runtime("local")
+
     if experimental_with_ibm_telemetry:
         merged_env_dict['USE_IBM_TELEMETRY'] = 'true'
 
@@ -806,10 +850,12 @@ def server_start(
 
 
     final_env_file = write_merged_env_file(merged_env_dict)
-    run_compose_lite(final_env_file=final_env_file, 
-                     experimental_with_langfuse=experimental_with_langfuse,
-                     experimental_with_ibm_telemetry=experimental_with_ibm_telemetry)
 
+    run_compose_lite(final_env_file=final_env_file,
+                     experimental_with_langfuse=experimental_with_langfuse,
+                     experimental_with_ibm_telemetry=experimental_with_ibm_telemetry,
+                     with_doc_processing=with_doc_processing)
+    
     run_db_migration()
 
     logger.info("Waiting for orchestrate server to be fully initialized and ready...")
@@ -836,6 +882,8 @@ def server_start(
 
     if experimental_with_langfuse:
         logger.info(f"You can access the observability platform Langfuse at http://localhost:3010, username: orchestrate@ibm.com, password: orchestrate")
+    if with_doc_processing:
+        logger.info(f"Document processing capabilities are now available for use in Flows (both ADK and runtime). Note: This option is currently available only in the Developer edition.")
 
 @server_app.command(name="stop")
 def server_stop(
@@ -845,6 +893,7 @@ def server_stop(
         help="Path to a .env file that overrides default.env. Then environment variables override both."
     )
 ):
+
     ensure_docker_installed()
     default_env_path = get_default_env_file()
     merged_env_dict = merge_env(
@@ -901,9 +950,24 @@ def server_logs(
 def run_db_migration() -> None:
     compose_path = get_compose_file()
     compose_command = ensure_docker_compose_installed()
+    default_env_path = get_default_env_file()
+    merged_env_dict = merge_env(default_env_path, user_env_path=None)
+    merged_env_dict['WATSONX_SPACE_ID']='X'
+    merged_env_dict['WATSONX_APIKEY']='X'
+    merged_env_dict['WXAI_API_KEY'] = ''
+    merged_env_dict['ASSISTANT_EMBEDDINGS_API_KEY'] = ''
+    merged_env_dict['ASSISTANT_LLM_SPACE_ID'] = ''
+    merged_env_dict['ROUTING_LLM_SPACE_ID'] = ''
+    merged_env_dict['USE_SAAS_ML_TOOLS_RUNTIME'] = ''
+    merged_env_dict['BAM_API_KEY'] = ''
+    merged_env_dict['ASSISTANT_EMBEDDINGS_SPACE_ID'] = ''
+    merged_env_dict['ROUTING_LLM_API_KEY'] = ''
+    merged_env_dict['ASSISTANT_LLM_API_KEY'] = ''
+    final_env_file = write_merged_env_file(merged_env_dict)
 
     command = compose_command + [
         "-f", str(compose_path),
+        "--env-file", str(final_env_file),
         "exec",
         "wxo-server-db",
         "bash",
@@ -943,4 +1007,4 @@ def run_db_migration() -> None:
         sys.exit(1)
 
 if __name__ == "__main__":
-    server_app()
+    server_app()

ibm_watsonx_orchestrate/cli/commands/toolkit/toolkit_command.py

@@ -47,7 +47,7 @@ def import_toolkit(
     ] = None,
     tools: Annotated[
         Optional[str],
-        typer.Option("--tools", "-t", help="Comma-separated list of tools to import. Or you can use `*` to use all tools"),
+        typer.Option("--tools", "-t", help="Comma-separated list of tools to import. Or you can use \"*\" to use all tools"),
     ] = None,
     app_id: Annotated[
         List[str],

ibm_watsonx_orchestrate/cli/commands/tools/tools_controller.py

@@ -41,7 +41,7 @@ from ibm_watsonx_orchestrate.client.connections import get_connections_client, g
 from ibm_watsonx_orchestrate.client.utils import instantiate_client, is_local_dev
 from ibm_watsonx_orchestrate.flow_builder.utils import import_flow_support_tools
 from ibm_watsonx_orchestrate.utils.utils import sanatize_app_id
-from ibm_watsonx_orchestrate.client.utils import is_local_dev
+from ibm_watsonx_orchestrate.utils.exceptions import BadRequest
 
 from  ibm_watsonx_orchestrate import __version__
 
@@ -400,7 +400,14 @@ The [bold]flow tool[/bold] is being imported from [green]`{file}`[/green].
     
 [bold cyan]Additional information:[/bold cyan]
 
-- The [bold green]Get flow status[/bold green] tool is being imported to support flow tools. This tool can query the status of a flow tool instance.  You can add it to your agent using the UI or including the following tool name in your agent definition: [green]i__get_flow_status_intrinsic_tool__[/green]. 
+- The [bold green]Get flow status[/bold green] tool is being imported to support flow tools. This tool can query the status of a flow tool instance. You can add it to your agent using the UI or including the following tool name in your agent definition: [green]i__get_flow_status_intrinsic_tool__[/green].
+
+[bold cyan]Experimental Features - Scheduling Flows and Agents: [/bold cyan]
+- You can now schedule any Flows to be run on a later time.  Just include the [bold green]"schedulable=True"[/bold green] attribute in the @flow decorator.
+- Once enabled, you can schedule a flow by saying something like: [bold green]Can you schedule the flow <flow_name> to run everyday at 7am EST for 3 times?[/bold green]
+- To schedule an agent, see the example in [bold green]examples/flow_builder/agent_scheduler[/bold green]. Use that to import the [bold green]agent_run[/bold green] tool to your agent. 
+- Use [bold green]agent_run[/bold green] tool to schedule an agent. For example: [bold green]Can you schedule the agent <agent_name> to run every weekday at 8am UK time?[/bold green]
+- In scheduling, it is important to mention timezone or UTC time (also known as Greenwich Mean Time or Coordinated Universal Time) will be used.
 
     """
 
@@ -477,7 +484,7 @@ The [bold]flow tool[/bold] is being imported from [green]`{file}`[/green].
                                  permission="read_only", 
                                  flow_model=model)   
     
-    tools = import_flow_support_tools()
+    tools = import_flow_support_tools(model=model)
     
     tools.append(tool)
 
@@ -554,7 +561,7 @@ class ToolsController:
                 tools = []
                 logger.warning("Skill Import not implemented yet")
             case _:
-                raise ValueError("Invalid kind selected")
+                raise BadRequest("Invalid kind selected")
 
         for tool in tools:
             yield tool