Customizing input-output schemas of prebuilt tools

Edit online

Many organizations customize their enterprise systems to support their unique business processes. Because of these customizations, the data structures and fields used in these systems might differ from the standard implementations provided by watsonx Orchestrate agents and tools.

To support seamless integration, tools that connect to these systems can be configured with custom schemas that match your organization’s environment. This enables watsonx Orchestrate to accurately exchange information by using the field names that are specific to your implementation.

Prebuilt catalog Agents with customizable tool schemas

The table below lists the prebuilt agents whose tools support customization of input and output schemas, organized by business domain and system.


Domain	System	Agents
HR	Oracle	Employee personal details Assign manager
HR	Workday	Leave management
IT	ServiceNow	All agents
	Jira
	GitLab
	Adobe
	Salesforce
	TestRail
Sales	Salesforce	CRM management Activity management
Sales	Microsoft dynamics	CRM management
Supply Chain	Order management system (OMS)	Order management

To learn more about prebuilt agents and tools, see:

Editing the schema for a tool

Watch the following video for an overview of customizing and editing tool schemas: Agent builder tool customization and schema editing guide.

To edit the schema:

From the , navigate to Build > All agents, select the required agent to open its Agent Builder page, then go to the Toolset section, or alternatively navigate to Build > All tools to modify and edit the schema.
Select the tool, and click the Options icon , and then select Edit details.
Click the Parameters tab. The input and output parameters for the schema is displayed.
Modify the schema by adding, removing, or updating input parameters or output parameters.
You can edit output parameters within the tool_output parameter.

Editing the input and output parameters can be controlled separately using the schema configuration for a tool. Input parameters might be locked, and output parameters might remain editable, or output parameters might be locked while input parameters remain editable. For information on authoring cutomizable python tools, see Authoring Python-Based Tools - Dynamic input and output schemas.

Depending on the schema configuration for the tool, a message is displayed to indicate whether you can edit the input parameters, output parameters, or both. Certain parameters might be locked for editing, and a lock icon is displayed in the Type column. You can still edit the description for a locked parameter, except when the parameter belongs to an MCP tool. However, you cannot delete the locked input or output parameters for any tools.

Note:

You can customize the schema to match the organization’s system, but if the custom schema does not align with the system, then the tool fails during runtime.

The Add input and Add output options are displayed on the dialog depending on the schema configuration for the tool. To add an input or output parameter, click Add input or Add output, select a type, and enter the parameter details such as the name, description, and other properties. After a parameter is added, it remains unlocked and can be edited.