Repository navigation
docs: add Agent Relay docs #28786
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
+173
−41
Merged
docs: add Agent Relay docs #28786
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
713c54a
docs(ai-coder/agent-relay): add Agent Relay docs
mattvollmer c930c67
docs(ai-coder/agent-relay): remove border from architecture diagram
mattvollmer bc598ff
docs(ai-coder/agent-relay): use inline style to remove image border
mattvollmer 5e9b434
Update docs/ai-coder/agent-relay/index.md
mattvollmer da4ead9
Update docs/ai-coder/agent-relay/index.md
mattvollmer 31cb023
Update docs/ai-coder/agent-relay/cursor.md
mattvollmer 7486435
docs(ai-coder/agent-relay): use semantic line breaks (one sentence pe…
mattvollmer 1a9e822
docs(ai-coder): outline agent execution options with links to Agent R…
mattvollmer 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: Agent Relay for Cursor | ||
| --- | ||
|
|
||
| > [!NOTE] | ||
| > Agent Relay for Cursor is in [early access](../../install/releases/feature-stages.md#early-access-features) and is currently in closed preview with select customers. | ||
|
|
||
| [Agent Relay](./index.md) connects [Cursor Cloud Agents](https://cursor.com/cloud) to self-hosted Coder workspaces. | ||
| Cursor also refers to this self-hosted worker model as [bring-your-own-machine (BYOM)](https://cursor.com/docs/cloud-agent/bring-your-own-machine). | ||
| Developers keep using the Cursor client and cloud agent workflow they already know. | ||
| The agent's tool calls run inside a Coder workspace on infrastructure you control instead of a Cursor-managed environment. | ||
|
|
||
| Cursor's agent orchestration and AI inference remain cloud-hosted. | ||
| Coder doesn't proxy or observe model inference. | ||
| Coder provides the workspace where the agent executes, and logs that correlate the Cursor session and user to that workspace. | ||
|
|
||
| ## How it works | ||
|
|
||
| 1. A developer selects a Cursor worker pool mapped to a Coder organization and workspace template, then starts a Cursor agent session. | ||
| 1. Agent Relay claims the pending Cursor request and asks the Coder control plane to provision a workspace from the mapped template for that user. | ||
| 1. A Cursor worker process inside the workspace connects to the corresponding Cursor cloud session and executes the agent's tool calls. | ||
| 1. When the session ends, Agent Relay manages workspace teardown. | ||
|
|
||
| Each Cursor agent session gets its own ephemeral workspace. | ||
|
mattvollmer marked this conversation as resolved.
|
||
|
|
||
| ## Requirements | ||
|
|
||
| - A licensed Coder deployment | ||
| - A Cursor Enterprise plan | ||
|
|
||
| ## Get started | ||
|
|
||
| Talk to your [Coder account team](https://coder.com/contact) or email [sales@coder.com](mailto:sales@coder.com) to get access to Agent Relay for Cursor. | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Agent Relay](./index.md) | ||
| - [Architecture](../../admin/infrastructure/architecture.md) | ||
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,56 @@ | ||
| --- | ||
| title: Agent Relay | ||
| --- | ||
|
|
||
| Agent Relay connects a cloud-hosted AI coding agent's hosted sessions to self-hosted [Coder workspaces](../../user-guides/workspace-management.md). | ||
| Developers keep the cloud agent's client and workflow. | ||
| Coder provides the workspace where the agent's tool calls run. | ||
|
|
||
| ## What Agent Relay does | ||
|
|
||
| Agent Relay watches for pending agent sessions from a supported provider. | ||
| When a session starts, Agent Relay provisions a Coder workspace from a mapped template and connects the session to a worker process inside that workspace. | ||
| The worker executes the agent's tool calls, such as reading files, running commands, and using development tools, against the resources available in that workspace. | ||
| Agent Relay manages the workspace for the life of the session and tears it down when the session ends. | ||
|
|
||
| <img src="../../images/guides/ai-agents/agent-relay-stack.png" alt="Agent Relay architecture diagram" style="border: none;"> | ||
|
|
||
| ## What Agent Relay is and isn't | ||
|
|
||
| Agent Relay changes where a cloud agent's tool calls execute. | ||
| It doesn't change where the agent's orchestration or AI inference run. | ||
| Those stay with the cloud provider. | ||
|
|
||
| Agent Relay is not: | ||
|
|
||
| - A replacement for [Coder Agents](../agents/index.md), Coder's own AI workflow infrastructure that runs its native agent loop inside the Coder control plane and calls out to your configured LLM provider for inference. | ||
| - A proxy or observability layer for a provider's AI inference. | ||
| Coder has no access to model selection or token usage for sessions that run through Agent Relay. | ||
| - A self-hosted deployment of a cloud provider's control plane. | ||
| The provider's orchestration stays cloud-hosted. | ||
|
|
||
| ## Business value | ||
|
|
||
| - Developers keep using the cloud agent client and workflow they already know. | ||
| - Platform and security teams control the infrastructure where agent sessions execute and which internal resources those sessions can reach. | ||
| - Agent sessions run in workspaces built from the same templates, networking, and governance controls as the rest of your Coder deployment. | ||
| - Each session gets its own workspace, provisioned on demand and deleted when the session ends. | ||
|
|
||
| ## Current state | ||
|
|
||
| Agent Relay is in [early access](../../install/releases/feature-stages.md#early-access-features) and is in closed preview with select customers. | ||
|
|
||
| ## Supported providers | ||
|
|
||
| [Cursor](./cursor.md) is the first provider Agent Relay supports. | ||
| Coder built Agent Relay to support additional cloud-hosted agent providers as they add support for self-hosted execution. | ||
|
mattvollmer marked this conversation as resolved.
|
||
|
|
||
| ## Get started | ||
|
|
||
| If you want access to Agent Relay or want updates on the support status for your cloud-hosted agent provider of choice, talk to your [Coder account team](https://coder.com/contact) or email [sales@coder.com](mailto:sales@coder.com). | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Agent Relay for Cursor](./cursor.md) | ||
| - [Coder Agents](../agents/index.md) | ||
| - [Architecture](../../admin/infrastructure/architecture.md) | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this and other instances technically have workspaces as capitalized? Def a nit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll sync with Nick. I think we might need to check the style guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a firm believer that there's a difference between Workspaces as a product, which should have the capital W, and an instance of the feature known as a workspace, with a lowercase w. My preference here is
self-hosted Coder workspaces.