Skip to content

docs: view how to resolve initialization issue with MCP server#1362

Merged
williamrusdyputra merged 10 commits into
mainfrom
docs/mcp-issue
Apr 23, 2026
Merged

docs: view how to resolve initialization issue with MCP server#1362
williamrusdyputra merged 10 commits into
mainfrom
docs/mcp-issue

Conversation

@williamrusdyputra
Copy link
Copy Markdown
Contributor

@williamrusdyputra williamrusdyputra commented Apr 23, 2026

resolves: https://github.com/holdex/hr-member-william-rusdyputra/issues/29

Summary by CodeRabbit

  • Documentation
    • Added troubleshooting guide for MCP/SSE initialization timeout issues in Claude Desktop
    • Includes step-by-step workaround instructions and configuration updates
    • Provides platform-specific file paths for macOS, Windows, and Linux

@williamrusdyputra williamrusdyputra self-assigned this Apr 23, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 23, 2026

📝 Walkthrough

Walkthrough

Documentation is added to docs/mcp-reverse-proxy.md describing an MCP/SSE initialization timeout failure mode in Claude Desktop. The section explains a workaround using globally installed mcp-remote and provides configuration file paths for macOS, Windows, and Linux.

Changes

Cohort / File(s) Summary
MCP Reverse Proxy Documentation
docs/mcp-reverse-proxy.md
Adds troubleshooting section for Claude Desktop MCP/SSE timeout issues, documenting a workaround involving global mcp-remote installation with absolute paths and config updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

type: docs

Suggested reviewers

  • MicBun
  • outerlook

Poem

🐰 Hops through the docs with glee,
A timeout fix for all to see!
Global paths and configs bright,
Claude Desktop now works just right!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: documentation on resolving an MCP server initialization issue, which aligns with the actual content added to the docs file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/mcp-issue

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@williamrusdyputra williamrusdyputra changed the title Docs/mcp issue docs: view how to resolve initialization issue with MCP server Apr 23, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
docs/mcp-reverse-proxy.md (2)

509-518: Consider adding concrete path examples.

The configuration example uses placeholder paths (/path/to/node, /path/to/node_modules/...). Adding platform-specific concrete examples would help users understand what these paths typically look like.

💡 Example enhancement
    ```json
    {
      "mcpServers": {
        "truf-postgres": {
          "command": "/path/to/node",
          "args": ["/path/to/node_modules/mcp-remote/dist/proxy.js", "https://your-domain.com/sse"]
        }
      }
    }
    ```
+
+   Example paths:
+   - **macOS (Homebrew)**: `/opt/homebrew/bin/node` and `/opt/homebrew/lib/node_modules/mcp-remote/dist/proxy.js`
+   - **macOS (nvm)**: `~/.nvm/versions/node/v20.0.0/bin/node` and `~/.nvm/versions/node/v20.0.0/lib/node_modules/mcp-remote/dist/proxy.js`
+   - **Linux**: `/usr/bin/node` and `/usr/lib/node_modules/mcp-remote/dist/proxy.js`
+   - **Windows**: `C:\Program Files\nodejs\node.exe` and `C:\Users\YourUser\AppData\Roaming\npm\node_modules\mcp-remote\dist\proxy.js`
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/mcp-reverse-proxy.md` around lines 509 - 518, Add concrete,
platform-specific example paths to the JSON example under the "mcpServers" ->
"truf-postgres" entry so readers know typical values for the "command" and
"args" fields; include examples for macOS (Homebrew and nvm), Linux, and Windows
showing typical node executable paths and corresponding global package paths for
mcp-remote (referencing the "command" key and the first element of "args" which
points to "mcp-remote/dist/proxy.js") and present them as short bullet-like
lines immediately after the existing JSON block.

520-523: Consider removing duplicate config file locations.

The config file locations listed here are already documented at lines 342-344. Since users likely consult this troubleshooting section after reading the main Claude Desktop configuration section, this repetition may be unnecessary. However, having the locations inline here does improve convenience for users jumping directly to this issue.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/mcp-reverse-proxy.md` around lines 520 - 523, Remove the duplicated
"Config file location:" block that repeats the macOS/Windows/Linux paths already
documented earlier; locate the exact block containing the lines starting with
"Config file location:" and the three entries "`~/Library/Application
Support/Claude/claude_desktop_config.json`",
"`%APPDATA%\\Claude\\claude_desktop_config.json`", and
"`~/.config/Claude/claude_desktop_config.json`" and delete it, or alternatively
replace it with a single concise cross-reference line pointing to the earlier
Claude Desktop configuration section to keep the troubleshooting page concise
while preserving quick access for readers who jump directly to this section.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/mcp-reverse-proxy.md`:
- Line 488: The GitHub issue reference modelcontextprotocol/typescript-sdk#86 in
the sentence mentioning "npx mcp-remote and Claude Desktop" is invalid; either
remove the entire issue link or replace it with the correct issue URL/number
that documents the initialize-response timeout. Update the line that currently
reads "See modelcontextprotocol/typescript-sdk#86" to either omit the
parenthetical reference or point to the accurate issue (or add a short footnote
explaining no public issue exists) so the docs no longer link to a nonexistent
issue.
- Around line 503-507: Remove the duplicated code block containing the two shell
commands "which node      # get node path" and "npm root -g     # get global
node_modules path" that appears twice in the docs; keep only one instance of
that fenced bash snippet under the "Find your paths and update the Claude
Desktop config" step so the commands are not repeated, and ensure the
surrounding fenced-code markers remain correctly formatted.

---

Nitpick comments:
In `@docs/mcp-reverse-proxy.md`:
- Around line 509-518: Add concrete, platform-specific example paths to the JSON
example under the "mcpServers" -> "truf-postgres" entry so readers know typical
values for the "command" and "args" fields; include examples for macOS (Homebrew
and nvm), Linux, and Windows showing typical node executable paths and
corresponding global package paths for mcp-remote (referencing the "command" key
and the first element of "args" which points to "mcp-remote/dist/proxy.js") and
present them as short bullet-like lines immediately after the existing JSON
block.
- Around line 520-523: Remove the duplicated "Config file location:" block that
repeats the macOS/Windows/Linux paths already documented earlier; locate the
exact block containing the lines starting with "Config file location:" and the
three entries "`~/Library/Application
Support/Claude/claude_desktop_config.json`",
"`%APPDATA%\\Claude\\claude_desktop_config.json`", and
"`~/.config/Claude/claude_desktop_config.json`" and delete it, or alternatively
replace it with a single concise cross-reference line pointing to the earlier
Claude Desktop configuration section to keep the troubleshooting page concise
while preserving quick access for readers who jump directly to this section.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 52eb8d7d-25e9-494e-936a-a6d3b41b8010

📥 Commits

Reviewing files that changed from the base of the PR and between 581c62f and e4d0bb6.

📒 Files selected for processing (1)
  • docs/mcp-reverse-proxy.md

Comment thread docs/mcp-reverse-proxy.md
Comment thread docs/mcp-reverse-proxy.md
@holdex
Copy link
Copy Markdown

holdex Bot commented Apr 23, 2026

Time Submission Status

Member Status Time Action Last Update
williamrusdyputra ✅ Submitted 5h Update time Apr 23, 2026, 6:44 PM

You can submit time with the command. Example:

@holdex pr submit-time 15m

See available commands to help comply with our Guidelines.

@williamrusdyputra
Copy link
Copy Markdown
Contributor Author

log: including the time it takes to deploy

@williamrusdyputra williamrusdyputra merged commit 279d79f into main Apr 23, 2026
7 checks passed
@williamrusdyputra williamrusdyputra deleted the docs/mcp-issue branch April 23, 2026 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants