Customize Tool Message Display
Customize the copy, level of detail, and result format shown in conversations when API, MCP, and Function tools run.
When an AI assistant calls a tool, you can control how much execution information appears in the conversation and format the tool results for easier reading. These settings apply to API, MCP, and Function tools.
Use Case
A customer service manager creates an API tool for looking up trial requests. She wants customer service agents to see the lookup progress without expanding all the technical details. On the tool's Display Copy tab, she selects Compact and configures the text displayed when execution finishes. When the assistant later calls the tool, customer service agents see a brief execution status instead of the tool's complete input and output.
Configure the Display
Select a Display Mode
Select a mode based on how much information conversation users need to see:
Follow conversation platform settings
Uses the conversation platform's default display behavior. The current default is Full.
Full
Displays complete tool execution information.
Compact
Displays only concise execution information.
Hidden
Does not display the tool execution block.
Hidden only hides the tool execution block in the conversation; it does not disable the tool. To prevent the AI assistant from calling the tool, go to the AI assistant's Tools settings and remove the tool from its configuration.
Customize the Display Copy
In the Display Copy section, click Add and configure the text displayed while the tool is running and after it finishes. The copy can use {{variable}} to insert a top-level parameter from the tool input, such as {{query}}. If the variable cannot be found, an empty string is displayed.
Configure the Output Rendering Template
To format the content returned by the tool, click Add in the Output Rendering Template section. The template can use {{output}} to insert the complete tool result or {{variable}} to insert a top-level parameter from the tool input. If the variable cannot be found, an empty string is displayed. If the template is left blank, the raw JSON is displayed.
When finished, click Confirm to save.
Recommendations for Selecting a Mode
Select Full when users need to verify the tool results.
Select Compact and provide clear display copy when users only need to know that the system is processing the request.
Select Hidden when execution details should not appear in the conversation.
After completing the setup, assign the tool to a test AI assistant and send a test question. Confirm that the display copy and output template match the fields actually returned by the tool.
Last updated
Was this helpful?
