Configuring the Gearset Agent

This guide covers each section of that page and when you would want to change it.

Related: Working with the Gearset Agent

Open the Gearset Agent, then select `Configure agent` at the bottom of the sidebar.

The page has its own tabs down the left-hand side: `General` and `Usage`.

Naming conventions are stored per pipeline, because different pipelines often follow different rules.

If your team has more than one pipeline, a `Pipeline` drop down appears at the top of the `General` tab. Select the pipeline you want to configure. If you only have one pipeline, the drop down is hidden and everything on the page applies to that pipeline.

The Gearset Agent learns your naming conventions the first time you chat with it on a pipeline. It samples the recent branches and pull requests in your repository, works out the pattern, and writes it into these two boxes as plain instructions.

You can then read what it learned and correct it. That is the point of this section: you are editing the instructions the agent follows, in your own words, rather than filling in a rigid template.

If you have not chatted with the agent on the selected pipeline yet, you will see a prompt to start a new chat instead of a text box. The boxes fill in on their own once the agent has had a look at your repository.

Where the agent gets a branch name from depends on whether there is a linked ticket.

- If the work has a linked Jira or Azure DevOps work item, the agent uses your pipeline's feature branch format. This is a pipeline setting rather than an agent setting, and the page links you straight to it. If a format is already set, it is shown next to the description.

- If there is no linked work item, the agent follows the branch instructions in the text box.

Write the instructions the way you would explain them to a new starter, for example:

Use kebab-case prefixed with feat/, fix/, or chore/.

Include the JIRA ticket key where one is available.

The agent will default to using a short sentence-cased description of what has changed for your commit messages.

Similar to the above, you can explicitly define a format that shows the ticket id, e.g.

When a ticket id is supplied, use [ticket-id] - plus a short, sentence-case summary of what changed. Otherwise, just write a short, sentence-case summary of what changed.

The same idea applies to pull requests. Describe how your team titles PRs and what the description should contain, for example:

Title PRs as `JIRA-<n>: <sentence-case summary>`.

Body uses Context, Changes, Testing, Risks sections.

The agent uses this when it pre-populates the `Title` and `Description` on the `Create pull request` screen. You can still edit either of those before you open the PR.

There is no save button. Your changes are saved when you click away from the text box.

The `Usage` tab shows how many of your team's credits have been used in the current period, and when they reset.

If you are running short, or have already used all your credits, select `Talk to us` to open a conversation with our team.

A few things that affect the agent are configured outside this page:

- Feature branch format is set on the pipeline itself, under the cog icon then `Edit pipeline details`. Used whenever the work has a linked ticket.

- Jira and Azure DevOps ticket linking is enabled per pipeline, under the cog icon then `Edit pipeline details`, then the `Jira` tab.

- Architectural and coding preferences are encoded in a `CLAUDE.md` or `AGENTS.md` file at the root of your repository. See Working with the Gearset Agent for details.