docs: refresh agents documentation#4491
Open
samwillis wants to merge 2 commits into
Open
Conversation
Bring the agents docs back in line with the current runtime APIs and add dedicated pages for newer capabilities like permissions, sandboxing, attachments, signals, and event sources. Co-authored-by: Cursor <cursoragent@cursor.com>
Remove the local planning document from the docs PR while preserving it in the working tree for continued reference. Co-authored-by: Cursor <cursoragent@cursor.com>
✅ Deploy Preview for electric-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for electric-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
KyleAMathews
reviewed
Jun 3, 2026
| | ----------------- | -------------------------------- | | ||
| | `--from <offset>` | Start streaming from this offset | | ||
|
|
||
| ### <span class="cli-command"><code>view <url> [--from <offset>]</code></span> {#view-url-from-offset} |
Contributor
There was a problem hiding this comment.
I didn't notice we added this (or forgot) — this doesn't seem necessary given we already have observe?
| outline: [2, 3] | ||
| --- | ||
|
|
||
| # Event sources |
Contributor
There was a problem hiding this comment.
hmm this name is very generic — it should just be webhook sources. Anything an agent can observe (all "subscribe" should be "observe") is an "event source". This probably needs cleaned up in code too.
| } | ||
| ``` | ||
|
|
||
| Agents should call `list_event_sources` first and use the advertised `sourceKey`, `bucketKey`, `paramsSchema`, and optional `filterKey`. |
Contributor
There was a problem hiding this comment.
Suggested change
| Agents should call `list_event_sources` first and use the advertised `sourceKey`, `bucketKey`, `paramsSchema`, and optional `filterKey`. | |
| Agents should call `list_webhook_sources` first and use the advertised `webhookKey`, `bucketKey`, `paramsSchema`, and optional `filterKey`. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Preview
https://deploy-preview-4491--electric-next.netlify.app/docs/agents/
Summary
Test plan
nvm use 22 && pnpm --dir website exec vitepress build .brave_search,removeTag, stalesend()/status snippets, and old attachment subject shape.Notes
pnpm --dir website run typecheckwas attempted earlier and still fails on pre-existing site-wide Vue type resolution issues unrelated to these docs changes.requestAnimationFramewarning in a blog component.Made with Cursor