Custom Aviator chips

Custom Aviator chips are buttons that appear in the Aviator pane of an entity. When clicked, the chip sends a preconfigured prompt to Aviator in the context of that entity. Use custom chips to surface repeatable AI tasks.

Configure a chip

Each chip is defined by a JSON configuration object. Add it directly in the external action editor, or include it in an uploaded bundle. For details, see External actions.

The prompt can be written inline (up to 1500 characters) or stored in an external .txt file for longer text.

Inline prompt

Copy code

{
  "name": "perform-coverage-analysis",
  "title": "Perform coverage analysis",
  "entity_type": ["feature"],
  "views": ["details"],
  "tooltip": "Analyze existing test coverage on feature functionality including all related entities",
  "mode": {
    "name": "aviator_chat",
    "prompt": "Perform coverage analysis. Specify which test is covering which backlog item and whether there is functionality specified that is not covered by any test."
  },
  "single_entity": true
}

External prompt file

When the prompt exceeds 1500 characters, store it in a .txt file inside a bundle and reference it with the {bundle_url} token:

Copy code

{
  "name": "suggest-feature-specification-completions",
  "title": "Suggest feature specification completions",
  "entity_type": ["feature"],
  "views": ["details"],
  "url": "{bundle_url}/prompts/specification-completions.txt",
  "tooltip": "Suggest missing sections in the feature specification",
  "mode": {
    "name": "aviator_chat"
  },
  "single_entity": true
}

Bundle structure:

Copy code

my-chips-bundle/
├── action-configuration.json
└── prompts/
    └── specification-completions.txt

Upload the zip bundle using the external action editor. For full upload instructions, see External actions.

JSON property reference

Property	Purpose	Notes
`name`	Required. Unique action name for identification/logging.	Keep stable once used.
`title`	Required. Label displayed on the chip.
`entity_type`	Required. Entity types where the chip appears.	REST entity names; aggregated types like `work_item` supported.
`views`	Required. Where the chip appears.	Typically `details`; `list` is also supported.
`tooltip`	Extended description shown when the user hovers over the chip.
`mode.name`	Required. Must be set to `"aviator_chat"`.
`mode.prompt`	Inline prompt text sent to Aviator when the chip is clicked.	Maximum 1500 characters. Cannot be used with `url`.
`url`	Path to a `.txt` file containing the prompt. Use `{bundle_url}` for files in the uploaded bundle.	Use when prompt exceeds 1500 characters. Cannot be used with `mode.prompt`.
`single_entity`	Selection constraint.	`true` recommended — chip is most meaningful with a single entity in context.
`workspaces`	Allow-list of workspace IDs.	Cannot be used with `exclude_workspaces`.
`exclude_workspaces`	Deny-list of workspace IDs.	Cannot be used with `workspaces`.

Hiding built-in chips

By default, built-in Aviator chips appear alongside custom chips. To show only custom chips, set the AVIATOR_DISPLAY_OOTB_CHIPS site parameter to false.