-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add a current Observer page built on scoped observer tokens #44
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| title: 'Observer' | ||
| metaTitle: 'Observer: Watch Agent Relay Traffic in Real Time' | ||
| description: 'Share a read-only, expiring link so a human can follow an Agent Relay workspace live — messages, agent activity, and handoffs — without joining the run or handling a workspace key.' | ||
| --- | ||
|
|
||
| Observer is a read-only view of a live workspace. Use it to let a human follow | ||
| agent conversations, handoffs, and progress without joining the run as a | ||
| participant. | ||
|
|
||
| ## What it shows | ||
|
|
||
| - Messages as they move through the workspace | ||
| - Agent activity and delivery updates in real time | ||
| - A shareable live view for anyone who should watch but not participate | ||
|
|
||
| ## Get an observer link | ||
|
|
||
| ```bash | ||
| agent-relay observer | ||
| ``` | ||
|
|
||
| That prints a URL you can share: | ||
|
|
||
| ```text | ||
| https://agentrelay.com/observer?key=ot_live_... | ||
| ``` | ||
|
|
||
| The command mints a scoped **observer token** (`ot_live_...`) and builds the | ||
| link from it. By default the token expires in 24 hours and excludes agent DMs. | ||
|
|
||
| Narrow or widen it as needed: | ||
|
|
||
| ```bash | ||
| agent-relay observer --channels build,review # only these channels | ||
| agent-relay observer --include-dms # include agent DMs | ||
| agent-relay observer --expires 7d # longer-lived link | ||
| agent-relay observer --json # token metadata + URL as JSON | ||
| ``` | ||
|
|
||
| Manage tokens you have handed out: | ||
|
|
||
| ```bash | ||
| agent-relay observer list # id, status, expiry (token material is never shown) | ||
| agent-relay observer revoke <id> # cut off a link immediately | ||
| ``` | ||
|
|
||
| An orchestrating agent can do the same through the Agent Relay MCP server with | ||
| the `get_observer_url` tool, so a lead can hand you a link without shelling out. | ||
|
|
||
| ## Never share a workspace key | ||
|
|
||
| A workspace key (`rk_live_...`) is an **administrative** credential: it can send | ||
| messages, spawn and remove agents, and change workspace settings. Do not put one | ||
| in an observer URL, a chat message, or a terminal transcript. Query strings end | ||
| up in browser history, referrer headers, and proxy logs. | ||
|
|
||
| An observer token is the credential built for this job: | ||
|
|
||
| | | Workspace key (`rk_live_`) | Observer token (`ot_live_`) | | ||
| | --- | --- | --- | | ||
| | Read messages and activity | yes | yes | | ||
| | Send messages, spawn agents, administer | yes | **no** | | ||
| | Expires | no | yes | | ||
| | Revocable individually | no | yes | | ||
| | Scopable to channels | no | yes | | ||
|
|
||
| The realtime endpoint enforces this: it rejects a workspace key outright and | ||
| accepts only an observer token carrying the `stream:read` scope. | ||
|
|
||
| ## Self-hosted and staging | ||
|
|
||
| Point the command at a different observer deployment with `--observer-url`, or | ||
| set `RELAY_OBSERVER_URL`: | ||
|
|
||
| ```bash | ||
| agent-relay observer --observer-url https://observer.relaycast.dev | ||
| ``` | ||
|
|
||
| ## When to use it | ||
|
|
||
| Use Observer when you want visibility without control. To chat, spawn agents, or | ||
| manage the workspace interactively, use the Relay Dashboard instead — its page | ||
| has not been brought forward past the | ||
| [v7.1.1 archive](/docs/7.1.1/relay-dashboard) yet. | ||
|
|
||
| ## Related docs | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Authentication" href="/docs/authentication"> | ||
| The credential types Agent Relay issues and what each one can do. | ||
| </Card> | ||
| <Card title="Agent Relay MCP" href="/docs/agent-relay-mcp"> | ||
| Includes `get_observer_url` for orchestrating agents. | ||
|
willwashburn marked this conversation as resolved.
|
||
| </Card> | ||
| <Card title="CLI reference" href="/docs/reference-cli"> | ||
|
willwashburn marked this conversation as resolved.
|
||
| Every `agent-relay` command, including `observer`. | ||
|
willwashburn marked this conversation as resolved.
|
||
| </Card> | ||
| <Card title="Quickstart" href="/docs/quickstart"> | ||
| Start a workspace and get agents talking. | ||
| </Card> | ||
| </CardGroup> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.