About the Tools Provider Service Plugin

The Tools Provider service plugin lets your app expose tools that Aria can discover and use during conversations with Wix users.

Expose any of your app's functionality as tools for Aria to use, including 3rd-party API and service integrations, data retrieval, workflows, and actions.

Before you begin

It's important to note the following before starting to code:

• Set up a CLI or self-managed project. For more details about supported development paths, see App Tools across development paths.
• Your app can include up to 100 tools.

Extensions configuration

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

• App Tools: A backend extension that declares which tools your app offers.
• Tools Provider: A service plugin that enables Aria to run a specified tool.

Additionally, your app must implement the runTool() handler so Aria can execute your tools.

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

Set up

Tools Provider handler

Use toolsProvider.provideHandlers() to define the following handler method in your app:

Method	Required
runTool()	Yes

When Aria selects a tool, Wix calls your handler with that tool's methodName and a payload shaped by the tool's 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.

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)