Add App Tools Extensions with the Wix CLI

App Tools extensions let your app expose custom tools that Aria can discover and run on behalf of Wix users in the site dashboard.

App Tools requires 2 separate extensions working together. This task walks you through creating both:

1. The App Tools declaration extension tells Aria what tools your app provides.
2. The Tools Provider service plugin handles the runtime call when Aria invokes a tool.

You must create and configure both extensions.

Before you begin

• You must have a project created using the CLI.
• You must be logged into your Wix account. If you don't have one, sign up for a Wix account.

Step 1 | Create the App Tools extension

Generate the extension file where you declare the tools your app exposes to Aria.

In the terminal:

1. Navigate to your project repo.

2. Run the generate command:

   Copy

3. Select App Tools from the menu and press Enter.

4. Enter a name for your extension when prompted.

The CLI generates the extension file and registers it in src/extensions.ts. For the generated folder structure and file contents, see App Tools Extension Files and Code.

Step 2 | Declare your tools

Configure the tools Aria can discover and call. Each tool configuration includes a name, a description, and optional request and response schemas.

Open the generated <your-extension-name>.extension.ts file and replace the stub tool declaration with your own. For field guidance and examples, see App Tools Extension Files and Code.

Step 3 | Create the Tools Provider service plugin

This step generates the runtime handler that Wix calls when Aria selects one of your declared tools. Creating a Tools Provider follows the same flow as any other service plugin. For details, see Add Service Plugin Extensions with the Wix CLI.

In the terminal:

1. Run the generate command again:

   Copy

2. Select Service Plugin from the menu and press Enter.

3. Select Tools Provider from the list of service plugin types.

4. Enter a name for your service plugin when prompted.

The CLI generates the extension files and registers them in src/extensions.ts.

Step 4 | Implement the handler

This step adds the business logic that runs when Aria calls one of your tools.

Open <your-provider-name>.ts and implement the runTool handler. Route on methodName to run the correct logic for each tool. Handle missing or unexpected fields in your implementation. For the generated file structure, see Service Plugin Extension Files and Code. For Tools Provider details and examples, see About the Tools Provider Service Plugin and the sample flows in the reference.

Build and deploy your project

Changes to App Tools extensions don't take effect until you build and release your project:

Delete App Tools extensions

To remove App Tools extensions from your project:

1. Delete the folder under src/extensions that contains your App Tools extension files.
2. Delete the folder under src/extensions that contains your Tools Provider service plugin files.
3. Remove the import and .use() statements for both extensions from your extensions.ts file.

If you already have a released version of your app, build and release again after removing the files.

See also

• About App Tools Extensions
• App Tools extension files and code
• About the Tools Provider Service Plugin
• About Service Plugin Extensions