docs: add troubleshooting section and pre-install version check - #29
Draft
OS-joaocastilho wants to merge 2 commits into
Draft
docs: add troubleshooting section and pre-install version check#29OS-joaocastilho wants to merge 2 commits into
OS-joaocastilho wants to merge 2 commits into
Conversation
Changes vs 0.6.3: - Add "Before you install" section instructing users to verify the plugin is on the latest version. Autoupdate is proving unreliable and users stuck on 0.6.0 / 0.6.2 keep hitting the pre-fix install prompt. - Add Troubleshooting section covering the four reported failure modes: "authenticate tool isn't loaded", "non-interactive session", "Server Disconnected", and Windows PATH. - Document the Reset procedure (uninstall plugin, Clear cache, restart, reinstall) as the recovery path when updates do not stick. - Add "Getting logs" section pointing at the per-server bridge log paths on macOS, Windows, and Linux. - Reword Step 5 of the Claude Code install prompt to allow the manual /mcp select outsystems Authenticate fallback instead of forbidding it. That fallback is currently the reliable rescue path across every reported failure. - Bump plugin version 0.6.3 -> 0.6.4. No functional or recipe changes to the actual install commands.
Changes vs previous commit on this branch: - Rewrite the "non-interactive session" entry. The prior text told users to update the plugin, but this error also surfaces on the current plugin release when the mcp-remote bridge is configured but no OAuth token is cached yet. Update-the-plugin does not resolve it. - Point users at the terminal-bootstrap workaround (npx -y mcp-remote https://<tenant>/mcp in a regular terminal), and clarify why: Claude Desktop's embedded agent runtime cannot open a browser tab from inside a chat turn, so token bootstrap has to happen out-of-process. - Mention the equivalent Claude Code CLI path (claude mcp -> Authenticate in an interactive terminal) as an alternative for that surface.
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
1 participant
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.
Summary
Changes vs 0.6.3:
No functional or recipe changes to the actual install commands.
Test plan