Labels
A project's own words pinned on its work items: pick labels on an item, filter the backlog by one, and shape the vocabulary from the backlog's label manager with a colour and a meaning for each word.
By the end of this page you will have given a project a short vocabulary of its own, pinned those words on the stories and bugs they describe, narrowed the backlog to one word, and renamed or retired a word without touching the items that carried it.
A label is a word a project pins on its work items: payments, tech-debt, client-asked.
The vocabulary belongs to the project, so two projects may use the same word for different things
and neither sees the other's list. Each word is unique within its project whatever its case,
carries a colour so the backlog reads at a glance, and may carry a meaning in one line so
two people pin it the same way. Labels are pinned from the item's editor and shown as chips on the
backlog's rows and in the item's flyout; the backlog filters by one. A label is not an artefact: it
carries no versions, and removing it unpins it everywhere without changing the items.
Before you begin
| You need | Where it comes from |
|---|---|
| A project | The registry or the intake wizard. |
work-item:view-any | To see the labels and filter by them; every role has it, a client guest included. |
work-item:update | To pin labels on an item and to add, rename or remove words; the roles that edit the backlog have it. |
Pin labels on an item
- Open the backlog and open an item for editing, or press New Item.
- Under Labels, pick the words that fit. The list is searchable; a word that does not exist yet is added from Manage Labels beside the heading, without leaving the editor.
- Save the item.
The chips appear under the item's title on the backlog and under Labels in its flyout, in the label's colour. Up to twenty labels fit on one item.
Filter by label
Pick a word in the Any label filter above the backlog. The list narrows to the items carrying it, the choice is kept in the page's address so a link sent to a colleague opens the same view, and clearing the filter brings every item back. The filter appears once the project has at least one label.
Manage the vocabulary
Press Manage Labels beside the Labels heading in an item's editor. The manager lists the project's words by name with how many items carry each, and offers three things to anyone who may edit the backlog:
- Add Label at the foot: a Word, a Colour from the palette and a Meaning; the word must be free within the project whatever its case. The new word is in every picker at once.
- Edit on a row rewrites the word, the colour or the meaning in place; every item carrying the label shows the new values at once, because an item points at the label rather than copying it.
- Remove on a row asks once, inline, then takes the word out of the vocabulary and off every item; the items are untouched. Keep backs out.
Viewers see the list and the counts without the form or the row buttons.
All the fields
What happens next
label.created,label.updatedandlabel.deletedgo out with the word and the colour; see thelabel.*events. Pinning or unpinning a label on an item announces nothing of its own: an item's labels travel with the item and are read back from the work items API aslabels.- A label is not part of an item's versions: restoring an earlier version of a story leaves its labels as they are, like its components.
- Heimdall and an agent connected over MCP read the vocabulary with
list_labelsbefore they draft or filter, and name labels by id when they list work items withlabel_id.
Managing
- Rename rather than replace: editing a word keeps it on every item; removing it and adding a new one starts from zero.
- A removed label disappears from every item and from the filter at once; the items keep their other labels and announce nothing.
- A deleted project takes its vocabulary with it.
- Client guests see the chips on the agreed items and may filter by them; they never shape the vocabulary.
Heimdall on this page
Heimdall reads a project's labels as part of its vocabulary and uses the words when it drafts or
summarises the backlog; an agent connected over MCP reads them with list_labels and pins them
through the stories it drafts. Neither coins, renames or removes a word: the vocabulary is the
team's, kept short on purpose.
From the API and MCP
Labels API
List a project's labels, add, rewrite and remove one.
Work items API
Pin labels with label_ids, read them back as labels, filter with label_id.
list_labels
A project's vocabulary with how many items carry each word.
label.* events
Added, rewritten, removed.
Permissions
| Action | Permission |
|---|---|
| See the labels and filter by one | work-item:view-any |
| Pin labels on an item | work-item:update, or work-item:create on a new item |
| Add, rename or remove a word | work-item:update |
Frequently asked
Related
- Backlog — the items the words are pinned on
- Components — the other way items are grouped, by the part of the product they change
- Traceability — relations between artefacts, as opposed to words on them
label.*webhook events
How is this guide?
Last updated on
Backlog
The Backlog page of a project: every story, task, sub-task, bug, spike and improvement with its reference, kind, status, priority, people, estimates and the fields its kind adds, its lifecycle, its hand-over and its versions.
Acceptance Criteria
The acceptance criteria rows on a work item: one sentence each with an optional Given, When and Then and a kind, written in the item's editor, ordered, versioned with the item and replaced over the API.