Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 2d16f59

Browse files
docs: add Agent Relay docs (#28786) (#28920)
1 parent 047827d commit 2d16f59

7 files changed

Lines changed: 173 additions & 41 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Agent Relay for Cursor
3+
---
4+
5+
> [!NOTE]
6+
> 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.
7+
8+
[Agent Relay](./index.md) connects [Cursor Cloud Agents](https://cursor.com/cloud) to self-hosted Coder workspaces.
9+
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).
10+
Developers keep using the Cursor client and cloud agent workflow they already know.
11+
The agent's tool calls run inside a Coder workspace on infrastructure you control instead of a Cursor-managed environment.
12+
13+
Cursor's agent orchestration and AI inference remain cloud-hosted.
14+
Coder doesn't proxy or observe model inference.
15+
Coder provides the workspace where the agent executes, and logs that correlate the Cursor session and user to that workspace.
16+
17+
## How it works
18+
19+
1. A developer selects a Cursor worker pool mapped to a Coder organization and workspace template, then starts a Cursor agent session.
20+
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.
21+
1. A Cursor worker process inside the workspace connects to the corresponding Cursor cloud session and executes the agent's tool calls.
22+
1. When the session ends, Agent Relay manages workspace teardown.
23+
24+
Each Cursor agent session gets its own ephemeral workspace.
25+
26+
## Requirements
27+
28+
- A licensed Coder deployment
29+
- A Cursor Enterprise plan
30+
31+
## Get started
32+
33+
Talk to your [Coder account team](https://coder.com/contact) or email [[email protected]](mailto:[email protected]) to get access to Agent Relay for Cursor.
34+
35+
## Learn more
36+
37+
- [Agent Relay](./index.md)
38+
- [Architecture](../../admin/infrastructure/architecture.md)

docs/ai-coder/agent-relay/index.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Agent Relay
3+
---
4+
5+
Agent Relay connects a cloud-hosted AI coding agent's hosted sessions to self-hosted [Coder workspaces](../../user-guides/workspace-management.md).
6+
Developers keep the cloud agent's client and workflow.
7+
Coder provides the workspace where the agent's tool calls run.
8+
9+
## What Agent Relay does
10+
11+
Agent Relay watches for pending agent sessions from a supported provider.
12+
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.
13+
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.
14+
Agent Relay manages the workspace for the life of the session and tears it down when the session ends.
15+
16+
<img src="../../images/guides/ai-agents/agent-relay-stack.png" alt="Agent Relay architecture diagram" style="border: none;">
17+
18+
## What Agent Relay is and isn't
19+
20+
Agent Relay changes where a cloud agent's tool calls execute.
21+
It doesn't change where the agent's orchestration or AI inference run.
22+
Those stay with the cloud provider.
23+
24+
Agent Relay is not:
25+
26+
- 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.
27+
- A proxy or observability layer for a provider's AI inference.
28+
Coder has no access to model selection or token usage for sessions that run through Agent Relay.
29+
- A self-hosted deployment of a cloud provider's control plane.
30+
The provider's orchestration stays cloud-hosted.
31+
32+
## Business value
33+
34+
- Developers keep using the cloud agent client and workflow they already know.
35+
- Platform and security teams control the infrastructure where agent sessions execute and which internal resources those sessions can reach.
36+
- Agent sessions run in workspaces built from the same templates, networking, and governance controls as the rest of your Coder deployment.
37+
- Each session gets its own workspace, provisioned on demand and deleted when the session ends.
38+
39+
## Current state
40+
41+
Agent Relay is in [early access](../../install/releases/feature-stages.md#early-access-features) and is in closed preview with select customers.
42+
43+
## Supported providers
44+
45+
[Cursor](./cursor.md) is the first provider Agent Relay supports.
46+
Coder built Agent Relay to support additional cloud-hosted agent providers as they add support for self-hosted execution.
47+
48+
## Get started
49+
50+
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 [[email protected]](mailto:[email protected]).
51+
52+
## Learn more
53+
54+
- [Agent Relay for Cursor](./cursor.md)
55+
- [Coder Agents](../agents/index.md)
56+
- [Architecture](../../admin/infrastructure/architecture.md)

docs/ai-coder/index.md

Lines changed: 55 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,69 @@
11
# Run AI Coding Agents in Coder
22

3-
Learn how to run & manage coding agents with Coder, both alongside existing
4-
workspaces and for background task execution.
3+
Learn how to run & manage coding agents with Coder, both alongside existing workspaces and for background task execution.
54

6-
## Agents in the IDE
7-
8-
Coder [integrates with IDEs](../user-guides/workspace-access/index.md) such as
9-
Cursor, Devin Desktop, and Zed that include built-in coding agents to work alongside
10-
developers. Additionally, template admins can
11-
[pre-install extensions](https://registry.coder.com/modules/coder/vscode-web)
12-
for agents such as GitHub Copilot.
5+
Coder supports several ways to run and [govern](#govern-ai-activity-with-ai-governance) coding agents, depending on how much control you need over execution and orchestration:
136

14-
These agents work well inside existing Coder workspaces as they can simply be
15-
enabled via an extension or are built-into the editor.
7+
- [Coder Agents](#coder-agents), self-hosted AI workflow infrastructure best suited for headless, automated background tasks and parallel agentic development in a conversational UI.
8+
- [Agent Relay](#agent-relay), best suited for preserving the cloud agent experience developers already know while running execution in self-hosted Coder workspaces.
9+
- [Agents in the IDE](#agents-in-the-ide), best suited for in-editor code assist use cases alongside a developer's existing workflow.
10+
- [Agents in workspace templates](#agents-in-workspace-templates), best suited for developers who want to pair one-on-one with an agent like Claude Code or Codex in a workspace.
1611

1712
## Coder Agents
1813

19-
In cases where the IDE is secondary, such as prototyping, research, or
20-
long-running background jobs, [Coder Agents](./agents/index.md) is the
21-
recommended way to delegate development work to coding agents in your Coder
22-
deployment.
14+
In cases where the IDE is secondary, such as prototyping, research, or long-running background jobs, [Coder Agents](./agents/index.md) is the recommended way to delegate development work to coding agents in your Coder deployment.
2315

24-
Coder Agents is a native AI coding agent built into Coder. The agent loop runs
25-
in the Coder control plane on your infrastructure rather than inside the
26-
workspace, so workspaces can be completely network isolated. Developers
27-
interact with agents through the web UI or the REST API.
16+
Coder Agents is a native AI coding agent built into Coder.
17+
The agent loop runs in the Coder control plane on your infrastructure rather than inside the workspace, so workspaces can be completely network isolated.
18+
Developers interact with agents through the web UI or the REST API.
2819

2920
![Coder Agents chat interface with git diff sidebar](../images/agents-hero-image.png)
3021

31-
[Learn more about Coder Agents](./agents/index.md) for architecture details,
32-
supported LLM providers, and how to get started.
22+
[Learn more about Coder Agents](./agents/index.md) for architecture details, supported LLM providers, and how to get started.
23+
24+
## Agent Relay
25+
26+
[Agent Relay](./agent-relay/index.md) connects a supported cloud-hosted AI agent provider's hosted sessions to self-hosted Coder workspaces.
27+
The provider's orchestration and AI inference stay cloud-hosted; a worker process inside the workspace executes the agent's tool calls.
28+
[Cursor Cloud Agents](https://cursor.com/cloud) is the first supported provider.
29+
30+
Agent Relay is in [early access](../install/releases/feature-stages.md#early-access-features) and is in closed preview with select customers.
31+
32+
[Learn more about Agent Relay](./agent-relay/index.md) for architecture details and supported providers.
33+
34+
## Agents in the IDE
35+
36+
Coder [integrates with IDEs](../user-guides/workspace-access/index.md) such as Cursor, Devin Desktop, and Zed that include built-in coding agents to work alongside developers.
37+
Additionally, template admins can [pre-install extensions](https://registry.coder.com/modules/coder/vscode-web) for agents such as GitHub Copilot.
38+
39+
These agents work well inside existing Coder workspaces as they can simply be enabled via an extension or are built-into the editor.
40+
41+
## Agents in workspace templates
42+
43+
Template admins can install terminal-based coding agents, such as Claude Code or Codex, directly into a workspace template using a [registry module](https://registry.coder.com).
44+
Pick from a curated list of agent modules in the [template builder](../admin/templates/creating-templates.md#template-builder), or add a module directly in Terraform:
45+
46+
```tf
47+
module "claude-code" {
48+
source = "registry.coder.com/coder/claude-code/coder"
49+
version = "~> 5.2"
50+
agent_id = coder_agent.main.id
51+
}
52+
```
53+
54+
Visit the [Coder Registry](https://registry.coder.com) for the full list of available agent modules.
55+
56+
[Learn more about extending templates](../admin/templates/extending-templates/index.md).
3357

3458
## Govern AI activity with AI Governance
3559

36-
AI coding tools are quickly becoming core to how engineering teams ship
37-
software. As adoption grows, platform teams want a clear picture of how AI is
38-
being used, consistent guardrails across teams, and predictable cost controls
39-
so they can confidently scale AI tooling to the whole organization.
40-
41-
[AI Governance](./ai-governance.md) is included with a Premium license and adds
42-
observability, management, and policy controls for AI tooling across your
43-
Coder deployment. It includes:
44-
45-
- [AI Gateway](./ai-gateway/index.md) for centralized authentication, audit
46-
trails of prompts and tool invocations, and policy enforcement against
47-
upstream LLM providers.
48-
- [Agent Firewall](./agent-firewall/index.md) for process-level network and
49-
command policies that restrict what agents can reach and do inside a
50-
workspace.
51-
[Learn more about AI Governance](./ai-governance.md) for use cases, entitlements,
52-
and how to enable it in your deployment.
60+
AI coding tools are quickly becoming core to how engineering teams ship software.
61+
As adoption grows, platform teams want a clear picture of how AI is being used, consistent guardrails across teams, and predictable cost controls so they can confidently scale AI tooling to the whole organization.
62+
63+
[AI Governance](./ai-governance.md) is included with a Premium license and adds observability, management, and policy controls for AI tooling across your Coder deployment.
64+
It includes:
65+
66+
- [AI Gateway](./ai-gateway/index.md) for centralized authentication, audit trails of prompts and tool invocations, and policy enforcement against upstream LLM providers.
67+
- [Agent Firewall](./agent-firewall/index.md) for process-level network and command policies that restrict what agents can reach and do inside a workspace.
68+
69+
[Learn more about AI Governance](./ai-governance.md) for use cases, entitlements, and how to enable it in your deployment.
331 KB
Loading

docs/manifest.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1136,6 +1136,20 @@
11361136
}
11371137
]
11381138
},
1139+
{
1140+
"title": "Agent Relay",
1141+
"description": "Connect supported cloud-hosted AI agents to self-hosted Coder workspaces with Agent Relay.",
1142+
"path": "./ai-coder/agent-relay/index.md",
1143+
"state": ["early access"],
1144+
"children": [
1145+
{
1146+
"title": "Agent Relay for Cursor",
1147+
"description": "Run Cursor's cloud agent sessions inside self-hosted Coder workspaces with Agent Relay.",
1148+
"path": "./ai-coder/agent-relay/cursor.md",
1149+
"state": ["early access"]
1150+
}
1151+
]
1152+
},
11391153
{
11401154
"title": "AI Governance",
11411155
"description": "Govern AI usage at scale with AI Governance: Agent Firewall, AI Gateway, and reporting.",

docs/reference/glossary.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Each entry gives a short definition and, where it helps, links to the page that
77
> Several Coder terms share the word "agent" but mean different things:
88
>
99
> - [Coder Agents](#coder-agents) is the AI product for delegating development work to coding agents.
10+
> - [Agent Relay](#agent-relay) connects a cloud-hosted AI agent provider's hosted sessions to self-hosted workspaces. It is not Coder Agents.
1011
> - A [workspace agent](#workspace-agent) is the process that runs inside a workspace to provide SSH, port forwarding, the web terminal, and other services.
1112
> - [`coder_agent`](#coder_agent) is the Terraform resource in a template that declares a workspace agent.
1213
@@ -24,6 +25,13 @@ It was previously named Agent Boundaries and uses a sandbox backend, `nsjail` by
2425
This feature requires a Premium license.
2526
Refer to [Agent Firewall](../ai-coder/agent-firewall/index.md).
2627

28+
### Agent Relay
29+
30+
A feature that connects a supported cloud-hosted AI agent provider's hosted sessions to self-hosted [workspaces](#workspace).
31+
The provider's orchestration and AI inference stay cloud-hosted; a worker process inside the workspace executes the agent's tool calls.
32+
In [early access](../install/releases/feature-stages.md#early-access-features).
33+
Refer to [Agent Relay](../ai-coder/agent-relay/index.md).
34+
2735
### AI Gateway
2836

2937
An LLM gateway in `coderd` that authenticates users, forwards traffic to providers such as OpenAI and Anthropic, audits prompts and tool invocations, and centralizes MCP administration.

docs/user-guides/workspace-management.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Workspaces
22

3-
A workspace is the environment that a developer works in. Developers in a team
4-
each work from their own workspace and can use
5-
[multiple IDEs](./workspace-access/index.md).
3+
A workspace is the environment where a developer or a coding agent works.
4+
Developers and agents in a team each work from their own workspace and can use [multiple IDEs](./workspace-access/index.md).
65

76
A developer creates a workspace from a
87
[shared template](../admin/templates/index.md). This lets an entire team work in

0 commit comments

Comments
 (0)