> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/building-connectors/manifest/aidescription.md).

# 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](/building-connectors/manifest/description.md), 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:

```json
{
    "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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/building-connectors/manifest/aidescription.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.