docs(mcp): document the CLI proxy transport and refresh the remote tool list - #1256
Draft
codyde wants to merge 1 commit into
Draft
docs(mcp): document the CLI proxy transport and refresh the remote tool list#1256codyde wants to merge 1 commit into
codyde wants to merge 1 commit into
Conversation
…ol list The Railway CLI now supports a `railway mcp proxy` transport that bridges the hosted MCP server (mcp.railway.com) over stdio using your existing `railway login`, so `railway mcp install --remote` no longer requires a browser OAuth step. The direct-URL OAuth flow moves to `railway mcp install --remote --oauth`. - cli/mcp.md: add the `proxy` subcommand, document the three install transports (local / remote-proxy / remote-oauth), the `--oauth` flag, the updated installed-entries table, and examples. - ai/mcp-server.md: clarify that remote connections use the CLI proxy (no browser) or OAuth; refresh the remote tool list to match the shipped server registry (workspaces, service CRUD, config, metrics, domains, docs search/fetch); add a CLI-proxy credential-handling note to the security section. - mcp-install-guide.tsx: correct the remote-mode caption, which still said `--remote` authenticates via OAuth. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
🚅 Deployed to the docs-pr-1256 environment in 🪄 *.railway.com
7 services not affected by this PR
|
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.
What changed in the product
railway mcp proxytransport: a local stdio bridge tomcp.railway.comthat authenticates with your existingrailway login.railway mcp install --remotenow installs this proxy, so the hosted server no longer requires a browser OAuth step for CLI users.railway mcp install --remote --oauth(and remains the only option for editors without the CLI).Docs updates
content/docs/cli/mcp.mdproxysubcommand.--oauthflag; update--remote's description.args: ["mcp", "proxy"]) and examples.content/docs/ai/mcp-server.mdpackages/backboard/.../mcp/tools/index.tson backboard master.src/components/mcp-install-guide.tsx--remoteauthenticates via OAuth.Reviewer note / open question
The interactive
<McpInstallGuide />has a two-mode (Local / Remote) toggle, where "Remote" shows the direct-URL config for each editor — which is now specifically the--remote --oauthpath. I fixed the caption to reconcile this, but did not restructure the per-editor toggle to add a distinct "proxy" configuration, since that's a larger component change. Worth deciding whether the interactive guide should surface the proxy stdio config (args: ["mcp", "proxy"]) per editor, or whether the prose +cli/mcp.mdtable is enough.Verification
tsc --noEmit).cli/mcp.mdfollows the no-em-dash house style;ai/mcp-server.mdedits match that file's existing bullet style.🤖 Generated with Claude Code