Developer Edition Server
Use these tools to start, stop, reset, or eject the local watsonx Orchestrate Developer Edition server without leaving your AI assistant. Each tool maps directly to its CLI equivalent.start_developer_edition_server
start_developer_edition_server
Start the local watsonx Orchestrate Developer Edition server.CLI equivalent:
orchestrate server startstring
Path to your
.env file.boolean
default:"false"
Accept the terms and conditions shown in the logs when the server starts.
boolean
default:"false"
Enable IBM Document Processing to extract information from business documents. This activates the Watson Document Understanding service.
boolean
default:"false"
Enable voice support.
boolean
default:"false"
Enable Langflow support. For more information about Langflow, see Authoring Langflow tools.
boolean
default:"false"
Enable support for AI assisted builder features. For more information about AI Builder, see AI Builder Overview.
stop_developer_edition_server
stop_developer_edition_server
reset_developer_edition_server
reset_developer_edition_server
Reset the local watsonx Orchestrate Developer Edition server. This stops the server, removes all Docker containers, and clears data volumes. Use this when you need a clean environment for development.CLI equivalent:
orchestrate server resetstring
Path to your
.env file.boolean
default:"false"
Keep the VM running the watsonx Orchestrate Developer Edition server.
eject_developer_edition_server
eject_developer_edition_server
Export the
docker-compose and .env files used to run the Developer Edition server to your working directory.CLI equivalent: orchestrate server ejectstring
required
Path to your
.env file.Environment Management
Use these tools to list, add, activate, or remove watsonx Orchestrate environments. Each tool maps directly to its CLI equivalent.list_environments
list_environments
List all configured environments in your watsonx Orchestrate setup and view the active environment.CLI equivalent:
orchestrate environment listThis tool takes no parameters.add_environment
add_environment
Add a remote watsonx Orchestrate environment to your configuration.CLI equivalent:
orchestrate environment addstring
required
Name of the environment.
string
required
URL endpoint for the watsonx Orchestrate instance.
string
Authentication type for the environment. Accepted values include
ibm_iam, mcsp, mcsp_v1, mcsp_v2, and cpd.boolean
default:"false"
Activate the environment immediately after adding it.
boolean
default:"false"
Bypass SSL certificate validation. Use this setting only for on-premises environments with self-signed certificates.
string
Path to a custom SSL certificate file for verification.
string
Custom IAM token endpoint URL for HIPAA-regulated clusters or MCSP V2 instances.
activate_environment
activate_environment
Activate and authenticate against a specified environment to target your requests to that instance.CLI equivalent:
orchestrate environment activatestring
required
Name of the environment to activate.
string
API key for authentication. Required for IBM Cloud and MCSP environments, or optional for on-premises environments when you authenticate alongside a username.
string
Username for on-premises Cloud Pak for Data environments.
string
Password for on-premises Cloud Pak for Data environments. Do not combine this field with an API key.
remove_environment
remove_environment
Remove a configured environment from your local settings.CLI equivalent:
orchestrate environment removestring
required
Name of the environment to remove.

