-
Notifications
You must be signed in to change notification settings - Fork 874
docs: clarify details around MCP #17220
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
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Custom Agents | ||
|
|
||
| > [!NOTE] | ||
| > | ||
| > This functionality is in early access and subject to change. Do not run in | ||
| > production as it is unstable. Instead, deploy these changes into a demo or | ||
| > staging environment. | ||
| > | ||
| > 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. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Coder deployment with v2.21 or later | ||
| - A [Coder workspace / template](./create-template.md) | ||
| - A custom agent that supports Model Context Protocol (MCP) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Coder uses the [MCP protocol](https://modelcontextprotocol.io/introduction) to report activity back to the Coder control plane. From there, activity is displayed in the Coder dashboard. | ||
|
|
||
| First, your template will need a [coder_app](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app) for the agent. This can be a web app or command run in the terminal and ideally gives the user a UI to interact with or view more details about the agent. | ||
|
|
||
| From there, the agent can run the MCP server with the `coder exp mcp server` command. You will need to set the `CODER_MCP_APP_STATUS_SLUG` environment variable to match the slug in the coder_app resource. | ||
|
|
||
| ## Example | ||
|
|
||
| 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 | ||
|
|
||
| # Use your own agent's logic and syntax here: | ||
| 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/modules/blob/main/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/modules/blob/main/CONTRIBUTING.md) for more information. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we're mentioning the app status slug, we should also add a note about also needing to specify
CODER_AGENT_TOKENfor app status reporting.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops! Will clarify