Skip to content

Update Activity Messages section in messages.mdx #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Activity Messages section in messages.mdx #773

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/concepts/messages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ interface ToolMessage {

### Activity Messages

Structured progress updates that appear between chat messages:
Structured UI messages that exist only on the frontend.
 Used for progress, status, or any custom visual element that shouldn’t be sent to the model:

```typescript
interface ActivityMessage {
Expand All @@ -122,11 +123,13 @@ interface ActivityMessage {
content: Record<string, any> // Structured payload rendered by the frontend
}
```
Key points
- Emitted via `ACTIVITY_SNAPSHOT` and `ACTIVITY_DELTA` to support live, updateable UI (checklists, steps, search-in-progress, etc.).
- **Frontend-only:** never forwarded to the agent, so no filtering and no LLM confusion.
- **Customizable:** define your own `activityType` and `content` and render a matching UI component.
- **Streamable:** can be updated over time for long-running operations.
- Helps persist/restore custom events by turning them into durable message objects.

Activity messages are populated by `ACTIVITY_SNAPSHOT` and `ACTIVITY_DELTA`
events. The structured `content` object gives frontends everything they need to
render bespoke status views, such as checklists, workflow progress, or search
results in flight.

### Developer Messages

Expand Down