About the App Tools APIs

The App Tools APIs let apps extend what AI agents can do on a Wix site, and let agents use those extensions. An app installed on a site can give agents such as Aria two things: tools, which are actions and lookups the app performs on request, and skills, which are the app's instructions for doing a job with those tools. The APIs cover both sides, the app that provides them and the agent that uses them.

The App Tools APIs include:

• Tools Provider: The service plugin an app implements to serve its tools. Wix calls it with a tool's method name and payload when an agent runs that tool, and passes the app's response back.
• Tools Host: The API agents call to retrieve the tools of the apps installed on a site and to run one of them, and the API site owners use to switch an app's tools off for their site.

They work together with the App Skills API, documented in its own section of the API reference: the API agents call to retrieve the skills of the apps installed on a site, with the guidelines to follow and the tools each skill may use.

How the pieces fit together

An app developer declares tools in the app's App Tools extension and implements the Tools Provider service plugin to serve them. Optionally, the developer declares skills in the app's App Skills extension, naming the tools each skill may call.

On a site where the app is installed, an agent retrieves the site's skills and tools, picks the skill or tool that fits the user's request, reads the skill's guidelines when there is one, and runs the tools through Tools Host. Wix routes each run to the app's Tools Provider implementation and returns the app's response to the agent. The site owner can switch an app's tools off at any time, per app or per tool, and the lists and Invoke Tool respect that.

Before you begin

It’s important to note the following points before starting to code:

• Everything is scoped to a site. Tools Host and App Skills take the site from the call's identity, and only apps installed on that site appear.
• Wix doesn't validate tool payloads or responses against the schemas an app declares. The schemas describe the app's contract; the app enforces it.

Terminology

• Tools provider: an app that exposes tools to agents. Identified by its app ID.
  • Tool: one action or lookup the app performs, identified by a method name within the app, with a JSON Schema for its payload.
• Skill: an app's instructions for one job, with the tools it may use. Served by the App Skills API; declared in the App Skills extension.
  • Guidelines: the Markdown instructions an agent follows once it has chosen the skill.
• Settings: a site's enable or disable state for an app's tools, as a whole or per tool.