> ## Documentation Index
> Fetch the complete documentation index at: https://docs.synq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Context entries

> Write down what people should know about a data asset, where they and AI assistants read it

A context entry is a short note that a person writes about a data asset. For example: "this table loads late on the first day of the month, so a freshness failure on that day is expected". People see the note on the asset page. AI assistants and the triage agent read it together with the asset.

An entry does not declare an incident. If the data is wrong, [declare an incident](https://docs.synq.io/incidents/incident-overview.md) instead.

## Kinds of entries

Each entry has a kind. The kind decides where people see the entry. AI assistants read every kind.

| Kind | What it is for | Where it shows |
| - | - | - |
| `Guidance` | How to judge a failure on this data, for example which severity fits, or when a failure is expected | The `Context` block of the asset page and of its checks |
| `Description` | What the data means, in your words | The `Description` block of the asset page, under the description from the source, with your name. The description from the source stays |
| `Announcement` | A notice that people must see first, for example a known delay or a planned removal | An alert at the top of the asset page |

An entry can have an end time. After that time it applies to nothing and no longer shows. Use an end time for an announcement about a delay or a planned change. The entry stays in the list, so you can find it and change it.

## What an entry applies to

An entry applies to one of these:

* One entity: a table, a view, a model, a dashboard or a check. A check is an entity too, so an entry can be about one dbt test, one monitor or one SQL test.
* Some columns of one entity, or fields of a semantic model. The entry shows with these columns.
* Every entity that filters select, for example every table of one schema, or every check of one category. A table or a check that matches later gets the entry too, and an entity that stops matching loses it.

Coalesce Quality computes the entities of a filter again every few minutes. So an entry with filters reaches its entities some minutes after you save it.

If a column is renamed or removed, its entries stay. They show the column name with a `Not found` badge.

## Where people see entries

### The asset page

Guidance shows in the `Context` block of the details panel. Below it, `About columns` lists the entries about columns of the asset. Click a column name to go to its row. Description entries show in the `Description` block, under the description from the source. Announcements show in one alert at the top of the page. The alert shows the newest announcement, and `Show all` opens the others.

![The Description and Context blocks of an asset page, with a guidance entry and an entry about the BUCKET column](https://mintcdn.com/synq-15/jfL5wOUVf2w_N7RD/images/context-entries/asset-context.png?fit=max\&auto=format\&n=jfL5wOUVf2w_N7RD\&q=85\&s=024386594f855ac42ff99e762f10fe1c)

An entry with filters shows `Applies to many entities`. Click it to see the entry in the list.

### A column

A column with entries has an icon next to its name. Hover over the icon to see how many entries it has. Open the row to read them. A description entry says `Written in Coalesce Quality. It is not from the source.`

![The row of the BUCKET column, open, with a description entry](https://mintcdn.com/synq-15/jfL5wOUVf2w_N7RD/images/context-entries/column.png?fit=max\&auto=format\&n=jfL5wOUVf2w_N7RD\&q=85\&s=e8ac93eb9ec5d9ecdf4f36b7221dc3a7)

The side panel of a field of a semantic model shows the entries about that field in the same way.

### A check

Click a check on the asset page to open its side panel. The `Context` block shows the guidance of the check. After it, the block shows the guidance of the tables that the check runs on, each with `On <table>` above it, so guidance written on a table shows on every check of that table.

![The side panel of a table stats check, with the guidance of its table under On EVENTS\_HOURLY](https://mintcdn.com/synq-15/jfL5wOUVf2w_N7RD/images/context-entries/check-panel.png?fit=max\&auto=format\&n=jfL5wOUVf2w_N7RD\&q=85\&s=42abb702610ac342a52bfec8166b6412)

### All entries

Go to Catalog → Context. The `Entries` tab lists every entry of the workspace, with its kind, what it applies to, its end time, and who changed it last. Click `Add filter` to show only some kinds or targets.

![Catalog → Context → Entries, with a description entry and a guidance entry](https://mintcdn.com/synq-15/jfL5wOUVf2w_N7RD/images/context-entries/entries.png?fit=max\&auto=format\&n=jfL5wOUVf2w_N7RD\&q=85\&s=0d1c0492cda18fcfe8c269edc3d7ba8b)

The other tabs of the page hold the [certified and deprecated](https://docs.synq.io/ownership/certified-and-deprecated.md) marks.

## Add an entry

1. Click `Add context` in one of these places:
   * The `Context` block of the asset page or of the side panel of a check. The entity is filled in.
   * The menu of a column row. The entity and the column are filled in.
   * Catalog → Context.
2. Enter the text, in Markdown, up to 4096 characters.
3. Select the kind: `Announcement`, `Description` or `Guidance`.
4. Under `Applies to`, select `One entity` or `Matching entities`.
   * For `One entity`, select the entity. Optionally, select columns. Without a column, the entry is about the whole entity.
   * For `Matching entities`, add filters. The dialog shows how many entities match now, and the list of them.
5. Optionally, set an end time.
6. Click `Add context`.

![The Add context dialog, with the text, the kind and the Applies to options](https://mintcdn.com/synq-15/jfL5wOUVf2w_N7RD/images/context-entries/add-context-dialog.png?fit=max\&auto=format\&n=jfL5wOUVf2w_N7RD\&q=85\&s=80622870b8c9702daafc70d9f55985d4)

## Edit or delete an entry

1. Go to Catalog → Context.
2. Click the menu at the end of the row of the entry.
3. Select `Edit` to change the entry, or `Delete` to remove it.

If someone else changed the entry after you opened it, the save fails. Open the entry again to see their change.

## Who can write entries

| Role | Read entries | Add, edit and delete entries |
| - | - | - |
| Admin, Developer | Yes | Yes |
| Analyst | Yes | No |
| Business User | Yes, in Catalog → Context | No |

The triage agent reads the entries, so only the roles that also manage checks and owners can write them. Read more about [user roles](https://docs.synq.io/admin/user_roles.md).

## AI assistants

The [Coalesce Quality MCP server](https://docs.synq.io/scout/mcp.md#context-from-the-workspace) gives the entries of an asset to an AI assistant together with the asset. `get_entity_details`, `get_schema` and `get_semantic_model` return them, with the announcements first. `get_entity_knowledge` returns them with the descriptions and knowledge pages of the assets. `list_context_entries` lists the entries of the workspace. `upsert_context_entry` and `delete_context_entry` write them, and need write access.

When the triage agent investigates an issue, it reads the entries of the check, of the table that the check runs on, and of the affected assets. It reads an entry about columns only if the check is on one of these columns. Write guidance there to tell the agent when a failure is expected, or how severe it is.

In the API, `synq.contextentries.v1alpha.ContextEntriesService` reads and writes the entries. Reading needs `SCOPE_CONTEXT_ENTRIES_READ`, writing needs `SCOPE_CONTEXT_ENTRIES_EDIT`. See the [API reference](https://docs.synq.io/api-reference/api.md) and [API scopes](https://docs.synq.io/api-reference/scopes.md). This API is in alpha, and its shape can change. A workspace can hold up to 500 entries.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.