Context Documents

Context Documents are entries that the Build Agent keeps for a workspace and reads at the beginning of every task. Every Creator in the workspace shares them. This article explains how the agent uses them and how Creators view, edit, and clear them in the Context tab. It also explains how administrators turn the feature on or off. For a comparison with chat context, see Build Agent Context.

How the Build Agent Uses Context Documents

Every workspace has a workspace overview, the first entry in its Context Documents. The agent loads this entry at the beginning of each task. The overview lists the workspace's applications and points to other entries for detail.

The agent opens other entries when the work calls for them. It also creates and updates entries as it works, and it explains each change in the chat. Each Creator can read and edit these entries, so the documents act as a shared store for the whole workspace.

The agent follows the conventions recorded in Context Documents when it builds. A request in the current task takes priority over a recorded convention.

An administrator can turn Context Documents off for an environment or for a single workspace. When the feature is off, the agent does not read or write entries, and the Context tab is hidden. For setup steps, see Administrator Settings.

Context Tab

The Context tab lists the Context Documents for the current workspace. Select the tab icon next to History in the Build Agent panel to open it.

When the workspace has no entries, the tab explains that the agent creates and maintains them as it works. Creators can also ask the agent to record something in the chat.

Entry Types

Each entry has one of the following types.

When the list grows long, filter buttons display above it. Select All or a type to narrow the list. The workspace overview always displays at the top.

Viewing and Editing an Entry

Select an entry in the Context tab to open it in the center of the Module Builder. The entry displays its title, type label, summary, and the following details line:

• The source of the last change, which is either the agent or a Creator.
• The version number.
• The date of the last change.

Hover over the details line to display the ID of the author.

The entry header has the following actions.

Version History

Select History in the entry header to list every saved version. Each row displays the version number, a change summary, the source of the change, and the date.

To review an earlier version:

1. Select a version in the list. The banner Viewing version N displays above the content.
2. Select Show changes or Hide changes to mark or unmark the lines that version added.
3. Select Back to current to return to the latest version.

Content Screening and Edit Conflicts

The platform checks each save for credentials, secrets, and text that reads as a prompt attack. When a save contains this kind of content, the platform rejects it and displays a message. Remove the flagged content and save again. Screening is a safeguard and does not replace care. Creators must not enter sensitive information in an entry.

If another Creator or the agent changes an entry after it is opened, a save displays a message that the entry changed. Reopen the entry to load the latest version, then apply the edit again. Deleting an entry follows the same rule.

Permissions

Context Documents follow workspace permissions.

Context Usage

Context Documents use part of the agent's working space. The Agent context row in the context gauge displays how much. The agent loads the workspace overview and the entry list at the beginning of each task. The row can display a share before the first reply. A larger overview and more entries raise the share and leave less room for the conversation.

Entries that Creators or the agent add or edit change the share for the next task. Deleting entries lowers it. For the other rows and what happens when the working space fills, see Context Usage Gauge.

When the Context Documents grow too large, the agent consolidates entries as it works. Creators can also edit or delete entries.

Clearing Context Documents

Creators with Admin permission on the workspace can delete all entries except the workspace overview.

To clear the Context Documents:

1. In the Context tab, select (ellipsis) to open Context actions.
2. Select Clear all topics.
3. Review the confirmation message, which states how many entries the action deletes, then select Confirm. Select Cancel to keep the entries.

Clearing cannot be undone.

Administrator Settings

Designer Administrators control where the Build Agent keeps Context Documents. One switch turns the feature on or off for the environment, and each workspace has its own switch. For the settings page and how the switches combine, see Context Documents Administration.

When Context Documents are off for a workspace, an open entry displays a message. The message states that the feature is turned off and that an administrator can turn it back on in Settings.