Skip to main content

Adding Tools

Tools define what AI is allowed to do with your application. Each tool represents a single, well-defined capability tied to a specific collection and action.

View all settings
SettingDescription
NameText input, required. Action-oriented tool name (e.g., Calculate Total Order Value).
DescriptionMulti-line text, required. Explains what the tool does and when to use it.
Select AreaDropdown, required. Application area containing the target collection.
Select CollectionDropdown, required. Data collection to operate on. Only shows collections configured for the selected Area.
Select Action TypeDropdown, required. Operation type (determined by ACL permissions).

Adding a Tool

1

Click 'Add Tool'

In the Tools panel, click the + Add Tool button to open the Tool Configuration dialog.

Tools Panel

2

Enter Name and Description

Choose a clear, action-oriented name and describe what the tool does.

Tool Configuration

Good names:

Calculate Total Order Value
List Customer Orders
Get Revenue Summary
Create Expense Report

Good descriptions:

Retrieves a list of financial transactions for a specified
date range. Returns transaction details including date,
amount, category, and description. Use this when the user
asks about specific transactions or spending patterns.
3

Select Area

Choose the application area that contains the collection you want to expose.

Select Area

An area can have multiple collections configured for it. Only collections explicitly assigned to this area will appear in the next dropdown.

4

Select Collection

Choose the data collection this tool will operate on.

Select Collection

Available collections depend on what has been configured for the selected Area. Examples include:

  • Users, SKUs, Warehouse Locations, Suppliers
  • Customer Orders, Stock On Hand, Stock Movements
  • Stock Adjustments, Warehouse Transfers, Cycle Counts
  • Inventory Items, Purchase Orders, Customer Order Items
5

Select Action Type

Choose the operation this tool will perform on the collection.

Select Action Type

Action Types

Action TypeOperationExample Use
ListRetrieve multiple recordsGet all transactions
SelectQuery with filters/conditionsSearch orders by status
DetailGet single record by IDView order details
CreateInsert new recordCreate expense report
UpdateModify existing recordUpdate budget allocation
DeleteRemove recordArchive old records
UploadHandle file uploadsUpload receipt image
ACL-Based Filtering

Action types are dynamically filtered based on your ACL configuration. If no role in the selected Area has permission for a specific action on any collection, that action type will not appear in the dropdown.

Tool Design Principles

Single Responsibility

Each tool should do one thing well. If you find yourself describing multiple capabilities, split them into separate tools.

Security Note

If a capability is not added as a tool, AI cannot access it. This is your primary security mechanism.

Automatic Parameters

Tool parameters are automatically generated based on the collection schema and action type you select. No manual parameter configuration is needed.

Next Steps