- Notifications
You must be signed in to change notification settings - Fork1k
feat: update tasks docs#18659
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
feat: update tasks docs#18659
Changes fromall commits
00e8387
9132992
b5b5862
fb29612
3e8b2a1
e853b03
39da22b
e555146
bdfaf60
e4a73ff
02e6b9c
b36c2dd
8e5b2df
0dae4e1
84060eb
da8873f
58d7c80
d3ea0ae
394180c
0762280
04b77a4
f8ab168
362bc55
d817640
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Uh oh!
There was an error while loading.Please reload this page.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,53 @@ | ||
#Best Practices | ||
This document includes a mix of cultural and technical best practices and guidelines for introducing AI agents into your organization. | ||
##Identify Use Cases | ||
To successfully implement AI coding agents, identify 3-5 practical use cases where AI tools can deliver real value. Additionally, find a target group of developers and projects that are the best candidates for each specific use case. | ||
Below are common scenarios where AI coding agents provide the most impact, along with the right tools for each use case: | ||
| Scenario| Description| Examples| Tools| | ||
|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| | ||
|**Automating actions in the IDE**| Supplement tedious development with agents| Small refactors, generating unit tests, writing inline documentation, code search and navigation|[IDE Agents](./ide-agents.md) in Workspaces| | ||
|**Developer-led investigation and setup**| Developers delegate research and initial implementation to AI, then take over in their preferred IDE to complete the work| Bug triage and analysis, exploring technical approaches, understanding legacy code, creating starter implementations|[Tasks](./tasks.md), to a full IDE with[Workspaces](../user-guides/workspace-access/index.md)| | ||
|**Prototyping & Business Applications**| User-friendly interface for engineers and non-technical users to build and prototype within new or existing codebases| Creating dashboards, building simple web apps, data analysis workflows, proof-of-concept development|[Tasks](./tasks.md)| | ||
|**Full background jobs & long-running agents**| Agents that run independently without user interaction for extended periods of time| Automated code reviews, scheduled data processing, continuous integration tasks, monitoring and alerting|[Tasks](./tasks.md) API*(in development)*| | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I tell a lot of customers that background jobs should always have a clear outcome withtests. I think it's good to explain that long-running tasks should have well-defined final states. | ||
|**External agents and chat clients**| External AI agents and chat clients that need access to Coder workspaces for development environments and code sandboxing| ChatGPT, Claude Desktop, custom enterprise agents running tests, performing development tasks, code analysis|[MCP Server](./mcp-server.md)| | ||
##Provide Agents with Proper Context | ||
While LLMs are trained on general knowledge, it's important to provide additional context to help agents understand your codebase and organization. | ||
###Memory | ||
Coding Agents like Claude Code often refer to a[memory file](https://docs.anthropic.com/en/docs/claude-code/memory) in order to gain context about your repository or organization. | ||
Look up the docs for the specific agent you're using to learn more about how to provide context to your agents. | ||
###Tools (Model Context Protocol) | ||
Agents can also use tools, often via[Model Context Protocol](https://modelcontextprotocol.io/introduction) to look up information or perform actions. A common example would be fetching style guidelines from an internal wiki, or looking up the documentation for a service within your catalog. | ||
Look up the docs for the specific agent you're using to learn more about how to provide tools to your agents. | ||
####Our Favorite MCP Servers | ||
In internal testing, we have seen significant improvements in agent performance when these tools are added via MCP. | ||
-[Playwright](https://github.com/microsoft/playwright-mcp): Instruct your agent | ||
to open a browser, and check its work by viewing output and taking | ||
screenshots. | ||
-[desktop-commander](https://github.com/wonderwhy-er/DesktopCommanderMCP): | ||
Instruct your agent to run long-running tasks (e.g.`npm run dev`) in the background instead of blocking the main thread. | ||
##Security & Permissions | ||
LLMs and agents can be dangerous if not run with proper boundaries. Be sure not to give agents full permissions on behalf of a user, and instead use separate identities with limited scope whenever interacting autonomously. | ||
[Learn more about securing agents with Coder Tasks](./security.md) | ||
##Keep it Simple | ||
Today's LLMs and AI agents are not going to refactor entire codebases with production-grade code on their own! Using coding agents can be extremely fun and productive, but it is important to keep the scope of your use cases small and simple, and grow them over time. |
This file was deleted.
Uh oh!
There was an error while loading.Please reload this page.
This file was deleted.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.