docs: add Agent Relay docs - #28786
Conversation
Add Agent Relay to the manifest as a new top-level entry after Coder Agents, with a child page for Cursor, both tagged early access. Agent Relay connects a supported cloud-hosted AI agent provider's hosted sessions to self-hosted Coder workspaces. The provider's orchestration and inference stay cloud-hosted; a worker process inside the workspace executes the agent's tool calls. Cursor Cloud Agents (Cursor's own bring-your-own-machine, or BYOM, terminology) is the first supported provider. Both pages state the feature is in closed preview with select customers and point readers to their Coder account team or [email protected] for access. Also: - Broaden the workspace definition on the Workspace Management page to include coding agents alongside developers. - Add glossary entries for Agent Relay, including it in the existing "agent" term-disambiguation callout alongside Coder Agents.
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
nickvigilante
left a comment
There was a problem hiding this comment.
LGTM with a few nits. Can you ask your agent to use semantic line breaks for this PR (one sentence per line)?
Co-authored-by: Nick Vigilante <[email protected]>
Co-authored-by: Nick Vigilante <[email protected]>
Co-authored-by: Nick Vigilante <[email protected]>
Documentation CheckThis is a docs-only PR that adds the Agent Relay pages. The changes are well-formed: Updates Needed
No new documentation needs in the latest push. Automated review via Coder Agents |
@matthew, is this intentional? |
Agree - I want to update this page. If it's not part of this PR, then as a follow-up. |
|
Follow-up PR is good with me; I won't block this PR on discoverability. |
…elay and template modules
| ## Agents in workspace templates | ||
|
|
||
| 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). | ||
| 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: | ||
|
|
||
| ```tf | ||
| module "claude-code" { | ||
| source = "registry.coder.com/coder/claude-code/coder" | ||
| version = "~> 5.2" | ||
| agent_id = coder_agent.main.id | ||
| } | ||
| ``` | ||
|
|
||
| Visit the [Coder Registry](https://registry.coder.com) for the full list of available agent modules. |
There was a problem hiding this comment.
We have not published the required module for agent-relay yet
There was a problem hiding this comment.
We have not published the required module for agent-relay yet
This section is unrelated to Agent Relay, but either way, we won't merge this PR until the registry is ready for Agent Relay.
@nickvigilante this commit updates the AI Coder index page and outlines the 4 common ways of running agents with Coder. |
| > [!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. |
There was a problem hiding this comment.
| [Agent Relay](./index.md) connects [Cursor Cloud Agents](https://cursor.com/cloud) to self-hosted Coder workspaces. | |
| [Agent Relay](./index.md) connects [Cursor Cloud Agents](https://cursor.com/cloud) to self-hosted Coder Workspaces. |
Should this and other instances technically have workspaces as capitalized? Def a nit
There was a problem hiding this comment.
I'll sync with Nick. I think we might need to check the style guide.
There was a problem hiding this comment.
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.
What this adds
Two new docs pages for Agent Relay, a feature that connects a supported cloud-hosted AI agent provider's hosted sessions to self-hosted Coder workspaces. The provider's orchestration and AI inference stay cloud-hosted; a worker process inside the workspace executes the agent's tool calls.
docs/ai-coder/agent-relay/index.md— top-level overview: what it is, what it does, what it is and isn't, business value, current state, and supported providers.docs/ai-coder/agent-relay/cursor.md— the Cursor-specific child page, naming Cursor Cloud Agents and Cursor's own bring-your-own-machine (BYOM) terminology.Both pages are tagged
"state": ["early access"]in the manifest and state the feature is in closed preview with select customers, pointing readers to their Coder account team or[email protected]for access.Also included
docs/user-guides/workspace-management.md: broadened the workspace definition to include coding agents alongside developers.docs/reference/glossary.md: added an Agent Relay entry (alphabetized between Agent Firewall and AI Gateway) and added it to the existing "agent" term-disambiguation callout, since it's easy to conflate with Coder Agents.Scope note for reviewers
Agent Relayitself (the underlying service, config, and worker implementation) lives in a separate, non-public repository. I don't have access to that source from this environment, so I deliberately kept both pages high-level and didn't invent specifics like CLI flags, config file structure, or exact command syntax. Before this goes further, someone with access to that repo should verify the mechanics described here (workspace-per-session lifecycle, provider pool mapping, worker connection model) against the real implementation, and a follow-up PR should add a step-by-step "Getting started" section once the feature moves past closed preview to something self-serve.Validation
docs/manifest.jsonis valid JSON.markdownlint-cli2: 0 issues across all changed/added Markdown files.vale --no-exit: 0 errors on every changed/added file (a handful of pre-existing gerund-heading warnings onworkspace-management.mdandglossary.mdpredate this branch and aren't touched here).scripts/check_emdash.sh: passes.Decision log
cursor.com/docs/cloud-agent/bring-your-own-machine) rather than inventing Coder-specific naming for the same concept.workspaceis the documented generic-concept casing, distinct from named features like "Workspace Proxy"), while still linking the term to the Workspace Management page.🤖 This PR was created by Coder Agents on behalf of @mattvollmer.