Customizing input-output schemas of prebuilt tools

Edit online

Many organizations use systems that are customized to meet specific business needs. The tools that connect to these systems might need different schemas than what comes from the standard, built-in implementations in watsonx Orchestrate. For example, there might be differences in terms of field names, and input or output parameters. As a result, tools that integrate with these systems require schemas that reflect an organization’s actual implementation rather than a generic default.

Editing the schema for a tool

To edit the schema:

  1. From the menu Menu, go to Build > All tools. Alternatively, navigate to your Agent Builder page, and go to the Toolset section.

  2. Select the tool, and click the Options icon option icon, and select Edit details.

  3. Click the Parameters tab. The input and output parameters for the schema is displayed.

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 example, you can use the Agent Development Kit (ADK) to configure Python tools with dynamic input and output schema (enable_dynamic_input_schema=True). For more information, 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.

Prebuilt catalog Agents with customizable tool schemas

The following prebuilt agents support customizable input and output schemas. The following table lists agents that have tools with dynamic schema, organized by business department:
Domain System Agents

HR

Oracle

  • Employee personal details

  • Assign manager

Workday

Leave management

IT

ServiceNow

All agents

Jira

GitLab

Adobe

Salesforce

TestRail

Sales

Salesforce

  • CRM management

  • Activity management

Microsoft dynamics

CRM management

Supply Chain

Order management system (OMS)

Order management
To learn more about prebuilt agents and tools, see: