Create an Applaud tool from a discovered API. The tool gives an AI assistant or workflow a clear, controlled capability to use Applaud data
Before you begin
- Step 1: Connect and discover Applaud tools to select the API you want to use.
Add the tool
After you select an API, Applaud takes you to the tool authoring experience.
Add a tool title
Enter a short, descriptive Tool Title.
The title helps administrators identify the tool in Agent Tools and helps distinguish it from similar tools.
For example:
Look up my recognitions
Review the tool name
Tool Name is the system name used by Applaud.
Applaud generates this name from the tool title, using lower_snake_case.
For example:
look_up_my_recognitions
You normally don't need to change the generated name.
Write the tool description
The Tool Description tells the AI assistant what the tool does and when to use it.
Write a description that clearly explains:
- What information or action the tool provides.
- When the assistant should use it.
- When the assistant shouldn't use it if another tool provides a similar capability.
For example:
Use when someone asks about recognitions or kudos stored in Applaud. Don't use for employee information stored in Workday.
A good description helps the assistant choose the right tool when several tools have similar capabilities.
Set the risk level
Select a Risk level for the tool.
Consider what happens when the tool runs:
- Low - Retrieves information without changing data.
- Medium - Performs an action that has a limited effect.
- High - Changes or deletes important or sensitive data.
For example, a GET operation that retrieves an employee's recognitions would typically have a lower risk than a DELETE operation.
Choose a risk level that reflects the potential impact of the tool, not just the API method it uses.
Add an activity message
Enter an Activity message to tell employees what the assistant is doing while the tool runs.
For example:
Looking up your recognitions...
Keep the message short and use plain language. Describe the action from the employee's perspective rather than exposing technical details.
For example:
- Good: Looking up your recognitions...
- Avoid: Calling GET/recognitions API...
The activity message appears while the tool is running. It doesn't replace the assistant's final response.
Add a category
You can optionally assign the tool to a Category.
Use categories to group related tools, making them easier to find and manage.
Choose a category that reflects the tool's purpose, such as Recognition, Employee data, or Documents.
Review the tool
Before moving on to configuration, review the tool details.
Check that:
- The title clearly describes what the tool does.
- The generated tool name is appropriate.
- The description explains when the assistant should use the tool.
- The risk level reflects the potential impact of the action.
- The activity message makes sense to the person using the assistant.
- The category is appropriate, if you've added one.
Next steps
After you've created the tool, configure how it sends and receives information.