For the complete documentation index, see llms.txt. This page is also available as Markdown.

aiDescription

Optional. A description of your component written for the AI Copilot rather than for the Designer UI. Copilot's component discovery prefers aiDescription and falls back to description, so a connector that does not define it behaves exactly as before.

Use it where the UI description is too short to steer the model — say what the component is for, and the nearest thing it is not for:

{
    "description": "Creates a customer in Salesforce.",
    "aiDescription": "Use this component when the user wants to create a new Salesforce Account or Contact. It does not update existing records."
}

aiDescription may be at most 1000 characters. It is read on every component-discovery call, which lists every component of an app at once, so keep it to a few sentences.

The field is also accepted in module and service manifests.

Last updated

Was this helpful?