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

Skip to content

Commit ed20bab

Browse files
EdwardAngertEdwardAngert
authored
docs: move AI-agent docs out of tutorials and into a top-level section (#17231)
redirects in: coder/coder.com#873 [preview](https://coder.com/docs/@move-ai-agents-up-1/coder-ai) - [x] icon - [x] shorten ~Modify or truncate the current~ title ~to reduce its length for improved readability, conciseness, or formatting consistency.~ - [x] Best practices & adding tools via MCP - edit title, desc, headings --------- Co-authored-by: EdwardAngert <[email protected]>
1 parent 1e0051a commit ed20bab

12 files changed

+110
-94
lines changed

‎docs/tutorials/ai-agents/README.md renamed to ‎docs/coder-ai/README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Run AI Agents in Coder (Early Access)
1+
# Use AI Coding Agents in Coder Workspaces
22

33
> [!NOTE]
44
>
5-
> This functionality is in early access and still evolving.
5+
> This functionality is in early access and is evolving rapidly.
6+
>
67
> For now, we recommend testing it in a demo or staging environment,
78
> rather than deploying to production.
89
>
@@ -14,19 +15,19 @@ AI Coding Agents such as [Claude Code](https://docs.anthropic.com/en/docs/agents
1415
- Protyping web applications or landing pages
1516
- Researching / onboarding to a codebase
1617
- Assisting with lightweight refactors
17-
- Writing tests and documentation
18+
- Writing tests and draft documentation
1819
- Small, well-defined chores
1920

2021
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.
2122

22-
![AI Agents in Coder](../../images/guides//ai-agents/landing.png)
23+
![AI Agents in Coder](../images/guides/ai-agents/landing.png)
2324

2425
## Prerequisites
2526

2627
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.
2728

28-
- A [Coder deployment](../../install/) with v2.21.0 or later
29-
- A Coder [template](../../admin/templates/) for your project(s).
29+
- A [Coder deployment](../install/index.md) with v2.21.0 or later
30+
- A Coder [template](../admin/templates/index.md) for your project(s).
3031
- Access to at least one ML model (e.g. Anthropic Claude, Google Gemini, OpenAI)
3132
- Cloud Model Providers (AWS Bedrock, GCP Vertex AI, Azure OpenAI) are supported with some agents
3233
- Self-hosted models (e.g. llama3) and AI proxies (OpenRouter) are supported with some agents

‎docs/tutorials/ai-agents/agents.md renamed to ‎docs/coder-ai/agents.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
> [!NOTE]
44
>
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.
5+
> This page is not exhaustive and the landscape is evolving rapidly.
6+
>
7+
> Please [open an issue](https://github.com/coder/coder/issues/new) or submit a
8+
> pull request if you'd like to see your favorite agent added or updated.
89
910
There are several types of coding agents emerging:
1011

‎docs/tutorials/ai-agents/best-practices.md renamed to ‎docs/coder-ai/best-practices.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Best Practices & Adding Tools via MCP
1+
# Model Context Protocols (MCP) and adding AI tools
22

33
> [!NOTE]
44
>
5-
> This functionality is in early access and still evolving.
5+
> This functionality is in early access and is evolving rapidly.
6+
>
67
> For now, we recommend testing it in a demo or staging environment,
78
> rather than deploying to production.
89
>
@@ -21,18 +22,20 @@ for development. With AI Agents, this is no exception.
2122

2223
## Best Practices
2324

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.
25+
- Use the most capable ML models you have access to in order to evaluate Agent
26+
performance.
2627
- Set a system prompt with the `AI_SYSTEM_PROMPT` environment in your template
2728
- Within your repositories, write a `.cursorrules`, `CLAUDE.md` or similar file
2829
to guide the agent's behavior.
2930
- To read issue descriptions or pull request comments, install the proper CLI
3031
(e.g. `gh`) in your image/template.
3132
- Ensure your [template](./create-template.md) is truly pre-configured for
3233
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
34+
are built, secrets are added/mocked, etc.).
35+
36+
> Note: [External authentication](../admin/external-auth.md) can be helpful
3537
> to authenticate with third-party services such as GitHub or JFrog.
38+
3639
- Give your agent the proper tools via MCP to interact with your codebase and
3740
related services.
3841
- Read our recommendations on [securing agents](./securing.md) to avoid

‎docs/tutorials/ai-agents/coder-dashboard.md renamed to ‎docs/coder-ai/coder-dashboard.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
> [!NOTE]
22
>
3-
> This functionality is in early access and still evolving.
3+
> This functionality is in early access and is evolving rapidly.
4+
>
45
> For now, we recommend testing it in a demo or staging environment,
56
> rather than deploying to production.
67
>
@@ -17,9 +18,9 @@
1718
Once you have an agent running and reporting activity to Coder, you can view
1819
status and switch between workspaces from the Coder dashboard.
1920

20-
![Coder Dashboard](../../images/guides/ai-agents/workspaces-list.png)
21+
![Coder Dashboard](../images/guides/ai-agents/workspaces-list.png)
2122

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

2425
## Next Steps
2526

‎docs/tutorials/ai-agents/create-template.md renamed to ‎docs/coder-ai/create-template.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
> [!NOTE]
44
>
5-
> This functionality is in early access and still evolving.
5+
> This functionality is in early access and is evolving rapidly.
6+
>
67
> For now, we recommend testing it in a demo or staging environment,
78
> rather than deploying to production.
89
>
@@ -27,7 +28,7 @@ template that has all of the tools and dependencies installed.
2728

2829
This can be done in the Coder UI:
2930

30-
![Duplicate template](../../images/guides/ai-agents/duplicate.png)
31+
![Duplicate template](../images/guides/ai-agents/duplicate.png)
3132

3233
## 2. Add a module for supported agents
3334

@@ -48,7 +49,7 @@ report status back to the Coder control plane.
4849

4950
The Coder dashboard should now show tasks being reported by the agent.
5051

51-
![AI Agents in Coder](../../images/guides//ai-agents/landing.png)
52+
![AI Agents in Coder](../images/guides/ai-agents/landing.png)
5253

5354
## Next Steps
5455

‎docs/tutorials/ai-agents/custom-agents.md renamed to ‎docs/coder-ai/custom-agents.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
> [!NOTE]
44
>
5-
> This functionality is in early access and still evolving.
5+
> This functionality is in early access and is evolving rapidly.
6+
>
67
> For now, we recommend testing it in a demo or staging environment,
78
> rather than deploying to production.
89
>

‎docs/tutorials/ai-agents/headless.md renamed to ‎docs/coder-ai/headless.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
> [!NOTE]
22
>
3-
> This functionality is in early access and still evolving.
3+
> This functionality is in early access and is evolving rapidly.
4+
>
45
> For now, we recommend testing it in a demo or staging environment,
56
> rather than deploying to production.
67
>
@@ -44,12 +45,12 @@ coder exp mcp configure cursor # Configure Cursor to interact with Coder
4445
## Coder CLI
4546

4647
Workspaces can be created, started, and stopped via the Coder CLI. See the
47-
[CLI docs](../../reference/cli/) for more information.
48+
[CLI docs](../reference/cli/index.md) for more information.
4849

4950
## REST API
5051

5152
The Coder REST API can be used to manage workspaces and agents. See the
52-
[API docs](../../reference/api/) for more information.
53+
[API docs](../reference/api/index.md) for more information.
5354

5455
## Next Steps
5556

‎docs/tutorials/ai-agents/ide-integration.md renamed to ‎docs/coder-ai/ide-integration.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
> [!NOTE]
22
>
3-
> This functionality is in early access and still evolving.
3+
> This functionality is in early access and is evolving rapidly.
4+
>
45
> For now, we recommend testing it in a demo or staging environment,
56
> rather than deploying to production.
67
>
@@ -21,7 +22,7 @@ Once you have an agent running and reporting activity to Coder, you can view the
2122
status and switch between workspaces from the IDE. This can be very helpful for
2223
reviewing code, working along with the agent, and more.
2324

24-
![IDE Integration](../../images/guides/ai-agents/ide-integration.png)
25+
![IDE Integration](../images/guides/ai-agents/ide-integration.png)
2526

2627
## Next Steps
2728

‎docs/tutorials/ai-agents/issue-tracker.md renamed to ‎docs/coder-ai/issue-tracker.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
> [!NOTE]
44
>
5-
> This functionality is in early access and still evolving.
5+
> This functionality is in early access and is evolving rapidly.
6+
>
67
> For now, we recommend testing it in a demo or staging environment,
78
> rather than deploying to production.
89
>
@@ -28,7 +29,7 @@ The [start-workspace](https://github.com/coder/start-workspace-action) GitHub
2829
action will create a Coder workspace based on a specific phrase in a comment
2930
(e.g. `@coder`).
3031

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

3334
When properly configured with an [AI template](./create-template.md), the agent
3435
will begin working on the issue.
@@ -39,15 +40,15 @@ We're working on adding support for an agent automatically creating pull
3940
requests and responding to your comments. Check back soon or
4041
[join our Discord](https://discord.gg/coder) to stay updated.
4142

42-
![GitHub Pull Request](../../images/guides/ai-agents/github-pr.png)
43+
![GitHub Pull Request](../images/guides/ai-agents/github-pr.png)
4344

4445
## Integrating with Other Issue Trackers
4546

4647
While support for other issue trackers is under consideration, you can can use
47-
the [REST API](../../reference/api/) or [CLI](../../reference/cli/) to integrate
48+
the [REST API](../reference/api/index.md) or [CLI](../reference/cli/index.md) to integrate
4849
with other issue trackers or CI pipelines.
4950

50-
In addition, an [Open in Coder](../../admin/templates/open-in-coder.md) flow can
51+
In addition, an [Open in Coder](../admin/templates/open-in-coder.md) flow can
5152
be used to generate a URL and/or markdown button in your issue tracker to
5253
automatically create a workspace with specific parameters.
5354

‎docs/tutorials/ai-agents/securing.md renamed to ‎docs/coder-ai/securing.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
> [!NOTE]
22
>
3-
> This functionality is in early access and still evolving.
3+
> This functionality is in early access and is evolving rapidly.
4+
>
45
> For now, we recommend testing it in a demo or staging environment,
56
> rather than deploying to production.
67
>

‎docs/images/icons/wand.svg

+3
Loading

‎docs/manifest.json

+62-61
Original file line numberDiff line numberDiff line change
@@ -667,6 +667,68 @@
667667
}
668668
]
669669
},
670+
{
671+
"title": "Run AI Coding Agents in Coder",
672+
"description": "Learn how to run and integrate AI coding agents like GPT-Code, OpenDevin, or SWE-Agent in Coder workspaces to boost developer productivity.",
673+
"path": "./coder-ai/README.md",
674+
"icon_path": "./images/icons/wand.svg",
675+
"state": ["early access"],
676+
"children": [
677+
{
678+
"title": "Learn about coding agents",
679+
"description": "Learn about the different AI agents and their tradeoffs",
680+
"path": "./coder-ai/agents.md"
681+
},
682+
{
683+
"title": "Create a Coder template for agents",
684+
"description": "Create a purpose-built template for your AI agents",
685+
"path": "./coder-ai/create-template.md",
686+
"state": ["early access"]
687+
},
688+
{
689+
"title": "Integrate with your issue tracker",
690+
"description": "Assign tickets to AI agents and interact via code reviews",
691+
"path": "./coder-ai/issue-tracker.md",
692+
"state": ["early access"]
693+
},
694+
{
695+
"title": "Model Context Protocols (MCP) and adding AI tools",
696+
"description": "Improve results by adding tools to your AI agents",
697+
"path": "./coder-ai/best-practices.md",
698+
"state": ["early access"]
699+
},
700+
{
701+
"title": "Supervise agents via Coder UI",
702+
"description": "Interact with agents via the Coder UI",
703+
"path": "./coder-ai/coder-dashboard.md",
704+
"state": ["early access"]
705+
},
706+
{
707+
"title": "Supervise agents via the IDE",
708+
"description": "Interact with agents via VS Code or Cursor",
709+
"path": "./coder-ai/ide-integration.md",
710+
"state": ["early access"]
711+
},
712+
{
713+
"title": "Programmatically manage agents",
714+
"description": "Manage agents via MCP, the Coder CLI, and/or REST API",
715+
"path": "./coder-ai/headless.md",
716+
"state": ["early access"]
717+
},
718+
{
719+
"title": "Securing agents in Coder",
720+
"description": "Learn how to secure agents with boundaries",
721+
"path": "./coder-ai/securing.md",
722+
"state": ["early access"]
723+
},
724+
{
725+
"title": "Custom agents",
726+
"description": "Learn how to use custom agents with Coder",
727+
"path": "./coder-ai/custom-agents.md",
728+
"state": ["early access"]
729+
}
730+
]
731+
},
670732
{
671733
"title": "Contributing",
672734
"description": "Learn how to contribute to Coder",
@@ -710,67 +772,6 @@
710772
"description": "Learn how to install and run Coder quickly",
711773
"path": "./tutorials/quickstart.md"
712774
},
713-
{
714-
"title": "Run AI Coding Agents with Coder",
715-
"description": "Learn how to run and secure agents in Coder",
716-
"path": "./tutorials/ai-agents/README.md",
717-
"state": ["early access"],
718-
"children": [
719-
{
720-
"title": "Learn about coding agents",
721-
"description": "Learn about the different AI agents and their tradeoffs",
722-
"path": "./tutorials/ai-agents/agents.md"
723-
},
724-
{
725-
"title": "Create a Coder template for agents",
726-
"description": "Create a purpose-built template for your AI agents",
727-
"path": "./tutorials/ai-agents/create-template.md",
728-
"state": ["early access"]
729-
},
730-
{
731-
"title": "Integrate with your issue tracker",
732-
"description": "Assign tickets to AI agents and interact via code reviews",
733-
"path": "./tutorials/ai-agents/issue-tracker.md",
734-
"state": ["early access"]
735-
},
736-
{
737-
"title": "Best practices \u0026 adding tools via MCP",
738-
"description": "Improve results by adding tools to your agents",
739-
"path": "./tutorials/ai-agents/best-practices.md",
740-
"state": ["early access"]
741-
},
742-
{
743-
"title": "Supervise agents via Coder UI",
744-
"description": "Interact with agents via the Coder UI",
745-
"path": "./tutorials/ai-agents/coder-dashboard.md",
746-
"state": ["early access"]
747-
},
748-
{
749-
"title": "Supervise agents via the IDE",
750-
"description": "Interact with agents via VS Code or Cursor",
751-
"path": "./tutorials/ai-agents/ide-integration.md",
752-
"state": ["early access"]
753-
},
754-
{
755-
"title": "Programmatically manage agents",
756-
"description": "Manage agents via MCP, the Coder CLI, and/or REST API",
757-
"path": "./tutorials/ai-agents/headless.md",
758-
"state": ["early access"]
759-
},
760-
{
761-
"title": "Securing agents in Coder",
762-
"description": "Learn how to secure agents with boundaries",
763-
"path": "./tutorials/ai-agents/securing.md",
764-
"state": ["early access"]
765-
},
766-
{
767-
"title": "Custom agents",
768-
"description": "Learn how to use custom agents with Coder",
769-
"path": "./tutorials/ai-agents/custom-agents.md",
770-
"state": ["early access"]
771-
}
772-
]
773-
},
774775
{
775776
"title": "Write a Template from Scratch",
776777
"description": "Learn how to author Coder templates",

0 commit comments

Comments
 (0)