About the Tools Provider Service Plugin

The Tools Provider service plugin lets your app expose tools that Aria, the Wix AI assistant, can discover and use during conversations with Wix users. Aria is available in the Wix Harmony editor and dashboard, and in the site dashboard of Wix Studio and the Wix Editor. In the site dashboard, Aria can access data such as the CMS, Wix business solutions, and monitoring tools. Learn more about Aria.

Using the Tools Provider service plugin, you can extend Aria's capabilities by exposing your app's functionality as tools. Any functionality your app can perform, you can expose as a tool for Aria to use. That includes retrieving data, running workflows, and completing actions in your app. It also includes functionality that uses 3rd-party APIs and services.

Use cases

• Get a package's status with Aria using a 3rd-party shipping service.
• Create or retrieve an invoice through a 3rd-party invoicing service, such as QuickBooks.
• Check inventory or place a fulfillment order with a dropshipping provider that your app uses.

App Tools extension and the Tools Provider service plugin

Exposing a tool to Aria requires you to configure the following backend extensions:

• App Tools: Declares which tools your app offers. Aria reads each tool's description to decide when to call it, and its requestSchema to collect the information it needs from the Wix user.
• Tools Provider: A service plugin that enables Aria to run a specified tool.

Implement the runTool() handler. When Aria selects a tool, Wix calls your handler with that tool's methodName and a payload shaped by its requestSchema. Your handler routes on methodName, runs the tool, and returns data matching the tool's responseSchema. Aria uses that response to answer the Wix user in natural language.

For an end-to-end example, see Get a package's status with Aria.

Set up

To set up the App Tools and Tools Provider extensions, go to Extensions in your app's dashboard.

App Tools

1. Click Create Extension in the top right.
2. Find App Tools and click Create.
3. Configure an array of tools in the JSON editor. For details, see About App Tools Extensions.
4. Click Save.

Tools Provider

1. Click Create Extension in the top right.
2. Find Tools Provider Config and click Create.
3. Set the Tools Provider Extension Config to enable Wix to locate your tools and expose them to Aria.
4. Click Save.

You can implement this service plugin in a CLI app or as a self-managed app. Use toolsProvider.provideHandlers() to define the following handler method:

Method	Required
runTool()	Yes

Code examples

See also

• About Aria
• AI on the Wix Platform
• App Tools
• About App Tools Extensions
• Add App Tools Extensions with the Wix CLI
• App Tools Extension Files and Code
• Add App Tools Extensions with the Wix CLI (Headless)
• App Tools Extension Files and Code (Headless)