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
Merged
Next Next commit
feat(docs): add AI agents tutorial and related resources
- Introduced a new section for running AI agents in Coder, including a README and a tutorial on picking an agent.
- Updated the manifest to include new entries for AI agents and their management.
- Added a new image for the AI agents landing page.
  • Loading branch information
bpmct committed Apr 1, 2025
commit a6dee7b8da469d8e25873ce6fe151920ba3f8cd6
Binary file added docs/images/guides/ai-agents/landing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
132 changes: 115 additions & 17 deletions docs/manifest.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"versions": ["main"],
"versions": [
"main"
],
"routes": [
{
"title": "About",
Expand Down Expand Up @@ -174,7 +176,9 @@
"description": "Use Coder Desktop to access your workspace like it's a local machine",
"path": "./user-guides/desktop/index.md",
"icon_path": "./images/icons/computer-code.svg",
"state": ["early access"]
"state": [
"early access"
]
},
{
"title": "Workspace Management",
Expand Down Expand Up @@ -218,7 +222,10 @@
"title": "Appearance",
"description": "Learn how to configure the appearance of Coder",
"path": "./admin/setup/appearance.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "Telemetry",
Expand Down Expand Up @@ -299,22 +306,33 @@
{
"title": "Groups \u0026 Roles",
"path": "./admin/users/groups-roles.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "IdP Sync",
"path": "./admin/users/idp-sync.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "Organizations",
"path": "./admin/users/organizations.md",
"state": ["premium"]
"state": [
"premium"
]
},
{
"title": "Quotas",
"path": "./admin/users/quotas.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "Sessions \u0026 API Tokens",
Expand Down Expand Up @@ -456,7 +474,10 @@
"title": "Process Logging",
"description": "Log workspace processes",
"path": "./admin/templates/extending-templates/process-logging.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
}
]
},
Expand All @@ -469,7 +490,10 @@
"title": "Permissions \u0026 Policies",
"description": "Learn how to create templates with Terraform",
"path": "./admin/templates/template-permissions.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "Troubleshooting Templates",
Expand All @@ -483,7 +507,10 @@
"description": "Learn how to run external provisioners with Coder",
"path": "./admin/provisioners.md",
"icon_path": "./images/icons/key.svg",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "External Auth",
Expand Down Expand Up @@ -559,13 +586,19 @@
"title": "Workspace Proxies",
"description": "Run geo distributed workspace proxies",
"path": "./admin/networking/workspace-proxies.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "High Availability",
"description": "Learn how to configure Coder for High Availability",
"path": "./admin/networking/high-availability.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "Troubleshooting",
Expand Down Expand Up @@ -599,19 +632,25 @@
"title": "Notifications",
"description": "Configure notifications for your deployment",
"path": "./admin/monitoring/notifications/index.md",
"state": ["beta"],
"state": [
"beta"
],
"children": [
{
"title": "Slack Notifications",
"description": "Learn how to setup Slack notifications",
"path": "./admin/monitoring/notifications/slack.md",
"state": ["beta"]
"state": [
"beta"
]
},
{
"title": "Microsoft Teams Notifications",
"description": "Learn how to setup Microsoft Teams notifications",
"path": "./admin/monitoring/notifications/teams.md",
"state": ["beta"]
"state": [
"beta"
]
}
]
}
Expand All @@ -627,7 +666,10 @@
"title": "Audit Logs",
"description": "Audit actions taken inside Coder",
"path": "./admin/security/audit-logs.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
},
{
"title": "Secrets",
Expand All @@ -638,7 +680,10 @@
"title": "Database Encryption",
"description": "Encrypt the database to prevent unauthorized access",
"path": "./admin/security/database-encryption.md",
"state": ["enterprise", "premium"]
"state": [
"enterprise",
"premium"
]
}
]
},
Expand Down Expand Up @@ -693,6 +738,59 @@
"description": "Learn how to install and run Coder quickly",
"path": "./tutorials/quickstart.md"
},
{
"title": "Run AI Agents in Coder",
"description": "Learn how to run and secure agents in Coder",
"path": "./tutorials/ai-agents/README.md",
"state": [
"early access"
],
"children": [
{
"title": "Learn about coding agents",
"description": "Learn about the different AI agents and their tradeoffs",
"path": "./tutorials/ai-agents/picking-an-agent.md"
},
{
"title": "Create a Coder template for agents",
"description": "Create a purpose-built template for your AI agents",
"path": "./tutorials/ai-agents/idk.md"
},
{
"title": "Integrate with your issue tracker",
"description": "Assign tickets to AI agents and interact via code reviews",
"path": "./tutorials/ai-agents/integrating-with-github.md"
},
{
"title": "Adding tools via MCP",
"description": "Improve results by adding tools to your agents",
"path": "./tutorials/ai-agents/adding-tools-via-mcp.md"
},
{
"title": "Supervise agents via Coder UI",
"description": "Interact with agents via the Coder UI",
"path": "./tutorials/ai-agents/managing-via-ui.md"
},
{
"title": "Supervise agents via the IDE",
"description": "Interact with agents via VS Code or Cursor",
"path": "./tutorials/ai-agents/managing-via-ide.md"
},
{
"title": "Programatically manage agents",
"description": "Manage agents via MCP, the Coder CLI, and/or REST API",
"path": "./tutorials/ai-agents/programmatically-managing-agents.md"
},
{
"title": "Securing agents with Boundaries",
"description": "Learn how to secure agents with boundaries",
"path": "./tutorials/ai-agents/securing-agents-with-boundaries.md",
"state": [
"premium"
]
}
]
},
{
"title": "Write a Template from Scratch",
"description": "Learn how to author Coder templates",
Expand Down
27 changes: 27 additions & 0 deletions docs/tutorials/ai-agents/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Run AI Agents in Coder (Early Access)

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:

- Protyping web applications or landing pages
- Researching / onboarding to a codebase
- Assisting with lightweight refactors
- Writing tests and documentation
- Well-defined "good first issues"

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.

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

## Prerequisites

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.

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

## Table of Contents

<children></chilren>
3 changes: 3 additions & 0 deletions docs/tutorials/ai-agents/picking-an-agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Picking an Agent

Lorem ipsum