docs: add built-in agents reference to README #3047
Conversation
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
rekram1-node
reviewed
Oct 8, 2025
|
|
||
| - **build** (default) - Full access agent for development work | ||
| - **plan** - Read-only agent for safe code exploration and analysis | ||
| - Denies file edits by default |
There was a problem hiding this comment.
this is in some ways, false, there is no edit tool at all for plan agent so I'd prolly reword this
There was a problem hiding this comment.
I see your point. Happy to reword if appropriate but it sounds like it may not be necessary. Thank you for your feedback.
|
Also @jayair may have opinions on putting this in readme, I think for most things having single source of truth for docs would be easiest |
|
That's a fair point about single source of truth. The README currently has minimal documentation by design. Happy to close this if you prefer keeping all agent docs at https://opencode.ai/docs/agents. @jayair - let me know your preference. |
This comment was marked as spam.
This comment was marked as spam.
|
Yeah I need to review the README anyway, so I'll take a look at this too. |
kmk142789
approved these changes
Oct 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
relates to: #882
Adds Agents section to README documenting the three built-in agents (build, plan, general).
Highlights plan agent's read-only mode for safe codebase exploration:
Links to full documentation at https://opencode.ai/docs/agents