Repository navigation
docs(opencode): cover the v2 MCP config shape - #3535
Open
OUAO-FRANK wants to merge 1 commit into
Open
OUAO-FRANK wants to merge 1 commit into
OUAO-FRANK wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
docs/installation-guides/install-opencode.mddocuments only the OpenCode v1 MCP configuration: servers directly undermcp, anenabled: trueflag, camelCase OAuth fields, and atoolsblock for hiding tools. OpenCode v2 accepts none of those shapes, so a reader following the guide ends up with a server that never connects and no diagnostic that explains why.The guide now leads with the version distinction and documents both shapes:
mcp.servers, they connect automatically, and a server is disabled with"disabled": true. Remote and local examples are updated to that shape, plus theopencode mcp add/--url/--header/--globalCLI path,/mcpsfor connect-disconnect-auth,opencode mcp listshowingconnected/needs authentication,permissionsactions (matching<server>_<tool>) instead of atoolsblock, and themcp.timeoutstartup/catalog/executionknobs.serverslevel,enabledversusdisabled, camelCase versus snake_case OAuth fields, andtoolsversuspermissions.disabled/enabledfield or theserverslevel is not recognised.Everything that is version-independent is unchanged: the PAT and environment-variable guidance, the
oauth: falseexplanation, the single-arraycommandshape, theenvironmentkey,{env:VAR_NAME}interpolation, the toolset/context warning, and the Docker prerequisites.Related issue
fixes #3450
(not mandatory) A picture of a cute animal, if possible in relation to what you did
Verification
Documentation-only change; no code paths touched.
git diff --stat→1 file changed, 151 insertions(+), 69 deletions(-), all of it insidedocs/installation-guides/install-opencode.md; no other file is modified.git ls-files --eolon the file reportsi/lf w/lf, so the LF endings and the repository's line-ending policy are preserved (no whole-file churn from an editor).mcp.servers,disabled,permissions,mcp.timeout,opencode mcp add --url/--header/--global) and, for the v1 section, against the v1 page (mcp.<name>,enabled,tools, camelCaseoauthfields).grep -n '"enabled"' docs/installation-guides/install-opencode.mdnow returns only the three intentional v1 occurrences; the v2 snippets usedisabled.https://opencode.ai/v2/docs/config,/v2/docs/permissions) resolve; the pre-existing relative links to../server-configuration.md,../oauth-login.md,./README.md, and../../README.md#available-toolsetsare unchanged and still exist in the tree.I did not run
script/testorscript/lint: neither covers Markdown content, and this diff contains no Go or UI files.