Skip to content

docs: add tutorials for using early access AI agent features #17186

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 14 commits into from
Apr 2, 2025
Prev Previous commit
Next Next commit
fix typos
  • Loading branch information
bpmct committed Apr 1, 2025
commit 2580d957607af55cac45f1f6f30e904bc8e9ae7f
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/guides/ai-agents/workspaces-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 12 additions & 9 deletions docs/tutorials/ai-agents/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,32 @@ with agents via any preferred tool such as via PR comments, within the IDE,
inside the Coder UI, or even via the REST API or an MCP client such as Claude
Desktop or Cursor.

| Agent | Supported Models | Coder Support | Limitations |
|---------------|---------------------------------------------------------|--------------------------------------------------------------------|---------------------------------------------------------|
| Claude Code ⭐ | Anthropic Models Only (+ AWS Bedrock and GCP Vertex AI) | First class integration ✅ | Beta (research preview) |
| Goose | Most popular AI models + gateways | First class integration ✅ | Less effective compared to Claude Code |
| Aider | Most popular AI models + gateways | Requires [MCP Plugin](https://github.com/lutzleonhardt/mcpm-aider) | Can only run 1-2 defined commands (e.g. build and test) |
| OpenHands | Most popular AI models + gateways | In progress ⏳ | Challenging setup, no MCP support |
| Agent | Supported Models | Coder Support | Limitations |
| -------------- | ------------------------------------------------------- | -------------------------- | ------------------------------------------------------- |
| Claude Code ⭐ | Anthropic Models Only (+ AWS Bedrock and GCP Vertex AI) | First class integration ✅ | Beta (research preview) |
| Goose | Most popular AI models + gateways | First class integration ✅ | Less effective compared to Claude Code |
| Aider | Most popular AI models + gateways | In progress ⏳ | Can only run 1-2 defined commands (e.g. build and test) |
| OpenHands | Most popular AI models + gateways | In progress ⏳ | Challenging setup, no MCP support |

[Claude Code](https://github.com/anthropics/claude-code) is our recommended
coding agent due to its strong performance on complex programming tasks.

> Note: Any agent can run in a Coder workspace via our
> [MCP integration](./headless.md).

## In-IDE agents

Coding agents can also run within an IDE, such as VS Code, Cursor or Windsurf.
These editors and extensions are fully supported in Coder and work well for more
complex and focused tasks where an IDE is strictly required.

| Agent | Supported Models | Coder Support |
|-----------------------------|-----------------------------------|--------------------------------------------------------------|
| Agent | Supported Models | Coder Support |
| --------------------------- | --------------------------------- | ------------------------------------------------------------- |
| Cursor (Agent Mode) | Most popular AI models + gateways | ✅ [Cursor Module](https://registry.coder.com/modules/cursor) |
| Windsurf (Agents and Flows) | Most popular AI models + gateways | ✅ via Remote SSH |
| Cline | Most popular AI models + gateways | ✅ via VS Code Extension |

In-IDE agents do not require a special template as they cannot be used in a
In-IDE agents do not require a special template as they are not used in a
headless fashion. However, they can still be run in isolated Coder workspaces
and report activity to the Coder UI.

Expand Down
5 changes: 3 additions & 2 deletions docs/tutorials/ai-agents/coder-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
Once you have an agent running and reporting activity to Coder, you can view
status and switch between workspaces from the Coder dashboard.

- TODO
- TODO
![Coder Dashboard](../../images/guides/ai-agents/workspaces-list.png)

![Workspace Details](../../images/guides/ai-agents/workspace-details.png)

## Next Steps

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/ai-agents/headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ or other tools with MCP support to interact with Coder in order to:
- Check in on agent activity

In this model, an [IDE Agent](./agents.md#in-ide-agents) could interact with a
remote Coder workspace, or Coder can be used in a remote pipeline or larger
remote Coder workspace, or Coder can be used in a remote pipeline or a larger
workflow.

The Coder CLI has options to automatically configure MCP servers for you. On
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/ai-agents/ide-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

## Overview

Once you have an agent running and reporting activity to Coder, you view status
and switch between workspaces from the IDE. This can be very helpful for
Once you have an agent running and reporting activity to Coder, you can view the
status and switch between workspaces from the IDE. This can be very helpful for
reviewing code, working along with the agent, and more.

![IDE Integration](../../images/guides/ai-agents/ide-integration.png)
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/ai-agents/issue-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ integrate with other issue trackers.
### GitHub Action

The [start-workspace](https://github.com/coder/start-workspace-action) GitHub
action will create a Coder workspace based on a specific comment (e.g.
`@coder`).
action will create a Coder workspace based on a specific phrase in a comment
(e.g. `@coder`).

![GitHub Issue](../../images/guides/ai-agents/github-action.png)

Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials/ai-agents/securing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ environments.
## Use Trusted Models

Most [agents](./agents.md) can be configured to either use a local LLM (e.g.
llama3), an agent proxy (e.g. OpenRouter), or a Cloud-Provided LLM through (e.g.
AWS Bedrock). Research which models you are comfortable with and configure your
llama3), an agent proxy (e.g. OpenRouter), or a Cloud-Provided LLM (e.g. AWS
Bedrock). Research which models you are comfortable with and configure your
[Coder templates](./create-template.md) use those.

## Set up Firewalls and Proxies

Many enterprises run Coder workspaces behind a firewall or proxy to prevent
Many enterprises run Coder workspaces behind a firewall or a proxy to prevent
threats or bad actors. These same protections can be used to ensure AI agents do
not access or upload sensitive information.

Expand All @@ -30,7 +30,7 @@ Many agents require API keys to access external services. It is recommended to
create a separate API key for your agent with the minimum permissions required.
This will likely involve editing your
[template for Agents](./create-template.md) to set different scopes or tokens
than the standard one.
from the standard one.

Additional guidance and tooling is coming in future releases of Coder.

Expand Down
Loading