[codex] Clarify MCP stdio provider docs#1058
Draft
mimeding wants to merge 4 commits into
Draft
Conversation
10 tasks
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.
Business rationale
Issue #416 reports a real mismatch between the documentation and the product surface: users were led to believe arbitrary command-based stdio MCP providers could be configured through the remote-provider UI, even though Osaurus remote MCP providers are URL-based HTTP/SSE endpoints and the supported local stdio bridge is
osaurus mcp. This repair keeps the branch scoped to documentation so reviewers can validate the user-facing guidance without re-reviewing old Swift/UI churn; the observable improvement is that the docs now distinguish first-partyosaurus mcpstdio from unsupported third-partycommand/argslaunchers.Coding rationale
The previous draft mixed docs, endpoint validation, UI text, and stale Swift changes from an old base. I repaired the branch by recording current
origin/mainancestry with a normal merge, restoring code/workflow/package files to current main, and reapplying only the docs changes allowed by lane T-E. I deliberately did not add the unrelated Swift formatting changes needed to satisfy the local full gate, because that would violate the docs-only trust boundary for this PR and make the maintainer review a mixed code/docs change.Acceptance criteria
osaurus mcpis documented as the supported stdio bridge.command/args,env, and working-directory stdio launchers are explicitly out of scope for remote providers.origin/mainis docs-only.swift-formatfailures that would require unrelated Swift edits in this docs-only lane.Quality gate
git diff --check origin/main..HEAD -- docs/DEVELOPER_TOOLS.md docs/FEATURES.md docs/REMOTE_MCP_PROVIDERS.md— cleangit diff --exit-code origin/main..HEAD -- Packages App .github .gitignore osaurus.xcworkspace— clean, proving no code/workflow/package diff remainsrg— cleanswift-format / swiftlint / shellcheck— blocked locally by unrelated current-main Swift formatting failuresswift test --package-path Packages/OsaurusCLI --parallel— not rerun for this draft repairmake ci-test— not rerun for this draft repairswift build --package-path Packages/OsaurusCore -c release— not rerun for this draft repairgit fetch --all --prunecompleted at 2026-05-17T13:00:49Z before pushDebug evidence
The repair changed the PR surface from mixed code/docs to docs-only. Before repair, PR #1058 listed Swift files such as
Packages/OsaurusCore/Managers/MCPProviderManager.swift,Packages/OsaurusCore/Views/Settings/ProvidersView.swift, andPackages/OsaurusCore/Tests/MCP/MCPProviderEndpointValidationTests.swift; after repair,git diff --name-status origin/main..HEADlists onlydocs/DEVELOPER_TOOLS.md,docs/FEATURES.md, anddocs/REMOTE_MCP_PROVIDERS.md. The pushed head is73e337c2b672b1b965c425d2ce4e2036b50131a2.Rollback
Revert this PR branch to the prior draft head
7d1f3c111191262c64d42b7972c5135461524b43, or close this draft and keep the current docs fromorigin/main.