Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commita61c3e7

Browse files
authored
docs: add tutorials for using early access AI agent features (#17186)
Some content is still being merged, but the structure is still therePreview:https://coder.com/docs/@ai-features/tutorials/ai-agents
1 parent4604f19 commita61c3e7

20 files changed

+498
-0
lines changed
198 KB
Loading
128 KB
Loading
243 KB
Loading
Loading
175 KB
Loading
Loading
Loading

‎docs/manifest.json

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -705,6 +705,60 @@
705705
"description":"Learn how to install and run Coder quickly",
706706
"path":"./tutorials/quickstart.md"
707707
},
708+
{
709+
"title":"Run AI Coding Agents with Coder",
710+
"description":"Learn how to run and secure agents in Coder",
711+
"path":"./tutorials/ai-agents/README.md",
712+
"state": ["early access"],
713+
"children": [
714+
{
715+
"title":"Learn about coding agents",
716+
"description":"Learn about the different AI agents and their tradeoffs",
717+
"path":"./tutorials/ai-agents/agents.md"
718+
},
719+
{
720+
"title":"Create a Coder template for agents",
721+
"description":"Create a purpose-built template for your AI agents",
722+
"path":"./tutorials/ai-agents/create-template.md",
723+
"state": ["early access"]
724+
},
725+
{
726+
"title":"Integrate with your issue tracker",
727+
"description":"Assign tickets to AI agents and interact via code reviews",
728+
"path":"./tutorials/ai-agents/issue-tracker.md",
729+
"state": ["early access"]
730+
},
731+
{
732+
"title":"Best practices\u0026 adding tools via MCP",
733+
"description":"Improve results by adding tools to your agents",
734+
"path":"./tutorials/ai-agents/best-practices.md",
735+
"state": ["early access"]
736+
},
737+
{
738+
"title":"Supervise agents via Coder UI",
739+
"description":"Interact with agents via the Coder UI",
740+
"path":"./tutorials/ai-agents/coder-dashboard.md",
741+
"state": ["early access"]
742+
},
743+
{
744+
"title":"Supervise agents via the IDE",
745+
"description":"Interact with agents via VS Code or Cursor",
746+
"path":"./tutorials/ai-agents/ide-integration.md",
747+
"state": ["early access"]
748+
},
749+
{
750+
"title":"Programmatically manage agents",
751+
"description":"Manage agents via MCP, the Coder CLI, and/or REST API",
752+
"path":"./tutorials/ai-agents/headless.md",
753+
"state": ["early access"]
754+
},
755+
{
756+
"title":"Securing agents in Coder",
757+
"description":"Learn how to secure agents with boundaries",
758+
"path":"./tutorials/ai-agents/securing.md"
759+
}
760+
]
761+
},
708762
{
709763
"title":"Write a Template from Scratch",
710764
"description":"Learn how to author Coder templates",

‎docs/tutorials/ai-agents/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#Run AI Agents in Coder (Early Access)
2+
3+
>[!NOTE]
4+
>
5+
>This functionality is in early access and subject to change. Do not run in
6+
>production as it is unstable. Instead, deploy these changes into a demo or
7+
>staging environment.
8+
>
9+
>Join our[Discord channel](https://discord.gg/coder) or
10+
>[contact us](https://coder.com/contact) to get help or share feedback.
11+
12+
AI Coding Agents such as[Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview),[Goose](https://block.github.io/goose/), and[Aider](https://github.com/paul-gauthier/aider) are becoming increasingly popular for:
13+
14+
- Protyping web applications or landing pages
15+
- Researching / onboarding to a codebase
16+
- Assisting with lightweight refactors
17+
- Writing tests and documentation
18+
- Small, well-defined chores
19+
20+
With Coder, you can self-host AI agents in isolated development environments with proper context and tooling around your existing developer workflows. Whether you are a regulated enterprise or an individual developer, running AI agents at scale with Coder is much more productive and secure than running them locally.
21+
22+
![AI Agents in Coder](../../images/guides//ai-agents/landing.png)
23+
24+
##Prerequisites
25+
26+
Coder is free and open source for developers, with a[premium plan](https://coder.com/pricing) for enterprises. You can self-host a Coder deployment in your own cloud provider.
27+
28+
- A[Coder deployment](../../install/) with v2.21.0 or later
29+
- A Coder[template](../../admin/templates/) for your project(s).
30+
- Access to at least one ML model (e.g. Anthropic Claude, Google Gemini, OpenAI)
31+
- Cloud Model Providers (AWS Bedrock, GCP Vertex AI, Azure OpenAI) are supported with some agents
32+
- Self-hosted models (e.g. llama3) and AI proxies (OpenRouter) are supported with some agents
33+
34+
##Table of Contents
35+
36+
<children></children>

‎docs/tutorials/ai-agents/agents.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
#Coding Agents
2+
3+
>[!NOTE]
4+
>
5+
>This page is not exhaustive and the landscape is evolving rapidly. Please
6+
>[open an issue](https://github.com/coder/coder/issues/new) or submit a pull
7+
>request if you'd like to see your favorite agent added or updated.
8+
9+
There are several types of coding agents emerging:
10+
11+
-**Headless agents** can run without an IDE open and are great for rapid
12+
prototyping, background tasks, and chat-based supervision.
13+
-**In-IDE agents** require developers keep their IDE opens and are great for
14+
interactive, focused coding on more complex tasks.
15+
16+
##Headless agents
17+
18+
Headless agents can run without an IDE open, or alongside any IDE. They
19+
typically run as CLI commands or web apps. With Coder, developers can interact
20+
with agents via any preferred tool such as via PR comments, within the IDE,
21+
inside the Coder UI, or even via the REST API or an MCP client such as Claude
22+
Desktop or Cursor.
23+
24+
| Agent| Supported Models| Coder Support| Limitations|
25+
|---------------|---------------------------------------------------------|---------------------------|---------------------------------------------------------|
26+
| Claude Code ⭐| Anthropic Models Only (+ AWS Bedrock and GCP Vertex AI)| First class integration ✅| Beta (research preview)|
27+
| Goose| Most popular AI models + gateways| First class integration ✅| Less effective compared to Claude Code|
28+
| Aider| Most popular AI models + gateways| In progress ⏳| Can only run 1-2 defined commands (e.g. build and test)|
29+
| OpenHands| Most popular AI models + gateways| In progress ⏳ ⏳| Challenging setup, no MCP support|
30+
31+
[Claude Code](https://github.com/anthropics/claude-code) is our recommended
32+
coding agent due to its strong performance on complex programming tasks.
33+
34+
>Note: Any agent can run in a Coder workspace via our
35+
>[MCP integration](./headless.md).
36+
37+
##In-IDE agents
38+
39+
Coding agents can also run within an IDE, such as VS Code, Cursor or Windsurf.
40+
These editors and extensions are fully supported in Coder and work well for more
41+
complex and focused tasks where an IDE is strictly required.
42+
43+
| Agent| Supported Models| Coder Support|
44+
|-----------------------------|-----------------------------------|--------------------------------------------------------------|
45+
| Cursor (Agent Mode)| Most popular AI models + gateways| ✅[Cursor Module](https://registry.coder.com/modules/cursor)|
46+
| Windsurf (Agents and Flows)| Most popular AI models + gateways| ✅ via Remote SSH|
47+
| Cline| Most popular AI models + gateways| ✅ via VS Code Extension|
48+
49+
In-IDE agents do not require a special template as they are not used in a
50+
headless fashion. However, they can still be run in isolated Coder workspaces
51+
and report activity to the Coder UI.
52+
53+
##Next Steps
54+
55+
-[Create a Coder template for agents](./create-template.md)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
#Best Practices & Adding Tools via MCP
2+
3+
>[!NOTE]
4+
>
5+
>This functionality is in early access and subject to change. Do not run in
6+
>production as it is unstable. Instead, deploy these changes into a demo or
7+
>staging environment.
8+
>
9+
>Join our[Discord channel](https://discord.gg/coder) or
10+
>[contact us](https://coder.com/contact) to get help or share feedback.
11+
12+
##Overview
13+
14+
Coder templates should be pre-equipped with the tools and dependencies needed
15+
for development. With AI Agents, this is no exception.
16+
17+
##Prerequisites
18+
19+
- A Coder deployment with v2.21 or later
20+
- A[template configured for AI agents](./create-template.md)
21+
22+
##Best Practices
23+
24+
- Since agents are still early, it is best to use the most capable ML models you
25+
have access to in order to evaluate their performance.
26+
- Set a system prompt with the`AI_SYSTEM_PROMPT` environment in your template
27+
- Within your repositories, write a`.cursorrules`,`CLAUDE.md` or similar file
28+
to guide the agent's behavior.
29+
- To read issue descriptions or pull request comments, install the proper CLI
30+
(e.g.`gh`) in your image/template.
31+
- Ensure your[template](./create-template.md) is truly pre-configured for
32+
development without manual intervention (e.g. repos are cloned, dependencies
33+
are built, secrets are added/mocked, etc.)
34+
>Note:[External authentication](../../admin/external-auth.md) can be helpful
35+
>to authenticate with third-party services such as GitHub or JFrog.
36+
- Give your agent the proper tools via MCP to interact with your codebase and
37+
related services.
38+
- Read our recommendations on[securing agents](./securing.md) to avoid
39+
surprises.
40+
41+
##Adding Tools via MCP
42+
43+
Model Context Protocol (MCP) is an emerging standard for adding tools to your
44+
agents.
45+
46+
Follow the documentation for your[agent](./agents.md) to learn how to configure
47+
MCP servers. See
48+
[modelcontextprotocol/servers](https://github.com/modelcontextprotocol/servers)
49+
to browse open source MCP servers.
50+
51+
###Our Favorite MCP Servers
52+
53+
In internal testing, we have seen significant improvements in agent performance
54+
when these tools are added via MCP.
55+
56+
-[Playwright](https://github.com/microsoft/playwright-mcp): Instruct your agent
57+
to open a browser, and check its work by viewing output and taking
58+
screenshots.
59+
-[desktop-commander](https://github.com/wonderwhy-er/DesktopCommanderMCP):
60+
Instruct your agent to run long-running tasks (e.g.`npm run dev`) in the
61+
background instead of blocking the main thread.
62+
63+
##Next Steps
64+
65+
-[Supervise Agents in the UI](./coder-dashboard.md)
66+
-[Supervise Agents in the IDE](./ide-integration.md)
67+
-[Supervise Agents Programmatically](./headless.md)
68+
-[Securing Agents](./securing.md)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
>[!NOTE]
2+
>
3+
>This functionality is in early access and subject to change. Do not run in
4+
>production as it is unstable. Instead, deploy these changes into a demo or
5+
>staging environment.
6+
>
7+
>Join our[Discord channel](https://discord.gg/coder) or
8+
>[contact us](https://coder.com/contact) to get help or share feedback.
9+
10+
##Prerequisites
11+
12+
- A Coder deployment with v2.21 or later
13+
- A[template configured for AI agents](./create-template.md)
14+
15+
##Overview
16+
17+
Once you have an agent running and reporting activity to Coder, you can view
18+
status and switch between workspaces from the Coder dashboard.
19+
20+
![Coder Dashboard](../../images/guides/ai-agents/workspaces-list.png)
21+
22+
![Workspace Details](../../images/guides/ai-agents/workspace-details.png)
23+
24+
##Next Steps
25+
26+
-[Supervise Agents in the IDE](./ide-integration.md)
27+
-[Supervise Agents Programmatically](./headless.md)
28+
-[Securing Agents](./securing.md)
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#Create a Coder template for agents
2+
3+
>[!NOTE]
4+
>
5+
>This functionality is in early access and subject to change. Do not run in
6+
>production as it is unstable. Instead, deploy these changes into a demo or
7+
>staging environment.
8+
>
9+
>Join our[Discord channel](https://discord.gg/coder) or
10+
>[contact us](https://coder.com/contact) to get help or share feedback.
11+
12+
##Overview
13+
14+
This tutorial will guide you through the process of creating a Coder template
15+
for agents.
16+
17+
##Prerequisites
18+
19+
- A Coder deployment with v2.21 or later
20+
- A template that is pre-configured for your projects
21+
- You have selected an[agent](./agents.md) based on your needs
22+
23+
##1. Duplicate an existing template
24+
25+
It is best to create a separate template for AI agents based on an existing
26+
template that has all of the tools and dependencies installed.
27+
28+
This can be done in the Coder UI:
29+
30+
![Duplicate template](../../images/guides/ai-agents/duplicate.png)
31+
32+
##2. Add a module for supported agents
33+
34+
We currently publish a module for Claude Code and Goose. Additional modules are
35+
[coming soon](./agents.md).
36+
37+
-[Add the Claude Code module](https://registry.coder.com/modules/claude-code)
38+
-[Add the Goose module](https://registry.coder.com/modules/goose)
39+
40+
Follow the instructions in the Coder Registry to install the module. Be sure to
41+
enable the`experiment_use_screen` and`experiment_report_tasks` variables to
42+
report status back to the Coder control plane.
43+
44+
>Alternatively, you can report status from a custom agent back to the Coder
45+
>control plane via our MCP server. For more information,
46+
>[join our Discord](https://discord.gg/coder) or
47+
>[contact us](https://coder.com/contact).
48+
49+
##3. Confirm tasks are streaming in the Coder UI
50+
51+
The Coder dashboard should now show tasks being reported by the agent.
52+
53+
![AI Agents in Coder](../../images/guides//ai-agents/landing.png)
54+
55+
##Next Steps
56+
57+
-[Integrate with your issue tracker](./issue-tracker.md)

‎docs/tutorials/ai-agents/headless.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
>[!NOTE]
2+
>
3+
>This functionality is in early access and subject to change. Do not run in
4+
>production as it is unstable. Instead, deploy these changes into a demo or
5+
>staging environment.
6+
>
7+
>Join our[Discord channel](https://discord.gg/coder) or
8+
>[contact us](https://coder.com/contact) to get help or share feedback.
9+
10+
##Prerequisites
11+
12+
- A Coder deployment with v2.21 or later
13+
- A[template configured for AI agents](./create-template.md)
14+
15+
##Overview
16+
17+
Once you have an agent running and reporting activity to Coder, you can manage
18+
it programmatically via the MCP server, Coder CLI, and/or REST API.
19+
20+
##MCP Server
21+
22+
Power users can configure[Claude Desktop](https://claude.ai/download), Cursor,
23+
or other tools with MCP support to interact with Coder in order to:
24+
25+
- List workspaces
26+
- Create/start/stop workspaces
27+
- Run commands on workspaces
28+
- Check in on agent activity
29+
30+
In this model, an[IDE Agent](./agents.md#in-ide-agents) could interact with a
31+
remote Coder workspace, or Coder can be used in a remote pipeline or a larger
32+
workflow.
33+
34+
The Coder CLI has options to automatically configure MCP servers for you. On
35+
your local machine, run the following command:
36+
37+
```sh
38+
coder mcp claude-desktop# Configure Claude Desktop to interact with Coder
39+
coder mcp cursor# Configure Cursor to interact with Coder
40+
```
41+
42+
##Coder CLI
43+
44+
Workspaces can be created, started, and stopped via the Coder CLI. See the
45+
[CLI docs](../../reference/cli/) for more information.
46+
47+
##REST API
48+
49+
The Coder REST API can be used to manage workspaces and agents. See the
50+
[API docs](../../reference/api/) for more information.
51+
52+
##Next Steps
53+
54+
-[Securing Agents](./securing.md)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
>[!NOTE]
2+
>
3+
>This functionality is in early access and subject to change. Do not run in
4+
>production as it is unstable. Instead, deploy these changes into a demo or
5+
>staging environment.
6+
>
7+
>Join our[Discord channel](https://discord.gg/coder) or
8+
>[contact us](https://coder.com/contact) to get help or share feedback.
9+
10+
##Prerequisites
11+
12+
- A Coder deployment with v2.21 or later
13+
- A[template configured for AI agents](./create-template.md)
14+
- VS Code, Windsurf, or Cursor IDE with the
15+
[Coder Extension](https://github.com/coder/vscode-coder/releases) v1.6.0+ or
16+
the[experimental AI VSIX](https://github.com/coder/vscode-coder/releases/)
17+
18+
##Overview
19+
20+
Once you have an agent running and reporting activity to Coder, you can view the
21+
status and switch between workspaces from the IDE. This can be very helpful for
22+
reviewing code, working along with the agent, and more.
23+
24+
![IDE Integration](../../images/guides/ai-agents/ide-integration.png)
25+
26+
##Next Steps
27+
28+
-[Programmatically manage agents](./headless.md)
29+
-[Securing Agents with Boundaries](./securing.md)

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp