mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
feat: update tasks docs (#18659)
Preview: https://coder.com/docs/@tasks-docs/ai-coder --------- Co-authored-by: Hugo Dutka <hugo@coder.com>
This commit is contained in:
@ -1,21 +1,11 @@
|
||||
# Custom Agents
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> This functionality is in beta and is evolving rapidly.
|
||||
>
|
||||
> When using any AI tool for development, exercise a level of caution appropriate to your use case and environment.
|
||||
> Always review AI-generated content before using it in critical systems.
|
||||
>
|
||||
> Join our [Discord channel](https://discord.gg/coder) or
|
||||
> [contact us](https://coder.com/contact) to get help or share feedback.
|
||||
|
||||
Custom agents beyond the ones listed in the [Coder registry](https://registry.coder.com/modules?tag=agent) can be used with Coder.
|
||||
Custom agents beyond the ones listed in the [Coder registry](https://registry.coder.com/modules?tag=agent) can be used with Coder Tasks.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Coder deployment with v2.21 or later
|
||||
- A [Coder workspace / template](./create-template.md)
|
||||
- A [Coder workspace / template](../admin/templates/creating-templates.md)
|
||||
- A custom agent that supports Model Context Protocol (MCP)
|
||||
|
||||
## Getting Started
|
||||
@ -31,8 +21,8 @@ From there, the agent can run the MCP server with the `coder exp mcp server` com
|
||||
Inside a Coder workspace, run the following commands:
|
||||
|
||||
```sh
|
||||
coder login # be sure to be authenticated with the Coder CLI
|
||||
export CODER_MCP_APP_STATUS_SLUG=my-agent # needs to be the same as the slug in the coder_app resource
|
||||
coder login
|
||||
export CODER_MCP_APP_STATUS_SLUG=my-agent
|
||||
|
||||
# Use your own agent's logic and syntax here:
|
||||
any-custom-agent configure-mcp --name "coder" --command "coder exp mcp server"
|
||||
@ -40,10 +30,9 @@ any-custom-agent configure-mcp --name "coder" --command "coder exp mcp server"
|
||||
|
||||
This will start the MCP server and report activity back to the Coder control plane on behalf of the coder_app resource.
|
||||
|
||||
> See the [Goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf) source code for a real world example.
|
||||
> [!NOTE]
|
||||
> See [this version of the Goose module](https://github.com/coder/registry/blob/release/coder/goose/v1.3.0/registry/coder/modules/goose/main.tf) source code for a real world example.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions for various agents via the [Coder registry](https://registry.coder.com/modules?tag=agent)!
|
||||
|
||||
See our [contributing guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md) for more information.
|
||||
We welcome contributions for various agents via the [Coder registry](https://registry.coder.com/modules?tag=agent)! See our [contributing guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md) for more information.
|
||||
|
Reference in New Issue
Block a user