Skip to content

docs: have agents run the MCP installer with --client - #907

Merged
lukepiette merged 1 commit into
docs/mcp-runpod-io-domainfrom
docs/agent-setup-installer-flags
Oct 21, 2026
Merged

lukepiette merged 1 commit into
docs/mcp-runpod-io-domainfrom
docs/agent-setup-installer-flags

Conversation

@lukepiette

Copy link
Copy Markdown
Contributor

Why

#892 made npx @runpod/mcp-server@latest add a User step, because the installer was a TTY-only wizard that exited 0 without writing config in an agent shell. runpod/runpod-mcp#119 fixed that, and it shipped in @runpod/mcp-server 4.3.0 (published today). This is the follow-up #119 called for.

What

In agent-setup.mdx, the "Cursor, GitHub Copilot, Windsurf, Cline, opencode, and all other agents" section:

  • Agents run npx @runpod/mcp-server@latest add --client <agent-id> themselves, with an id table: cursor, windsurf, vscode (GitHub Copilot), opencode, claude-desktop.
  • Notes Node 20+, the exit codes (0 / 1 / 2), add --list, that --client is always required in an agent shell, and that the installer prints each client's sign-in step for the agent to do or relay.
  • Removes the "Do not run it yourself" warning and the User step.
  • Keeps the manual config entry for agents the installer doesn't support (Cline and others). Pi keeps its own pi mcp add section.

Testing

  • Ran the published 4.3.0 in a throwaway HOME: --version → 4.3.0; add --help and add --list work; add with no --client and no TTY → exit 2, nothing written; add --client cursor,opencode → exit 0, valid entries written to .cursor/mcp.json and opencode/opencode.json, with the sign-in step printed for each.
  • mint validate: build validation passed.
  • mint broken-links: 7 existing broken links on organizations/orgs-overview.mdx and storage/globalvolume/overview.mdx; none on this page.
  • node scripts/validate-tooltips.js passes.

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Oct 15, 2026, 10:56 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@runpod/mcp-server 4.3.0 adds a no-prompt mode (add --client <ids>) with
honest exit codes and opencode support. Agents can now run the installer
themselves, so the agent-setup page drops the User step that handed it
to the user.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lukepiette
lukepiette force-pushed the docs/agent-setup-installer-flags branch from ca48f88 to d958002 Compare October 21, 2026 21:09
@lukepiette
lukepiette changed the base branch from main to docs/mcp-runpod-io-domain October 21, 2026 21:09
@lukepiette
lukepiette merged commit d958002 into docs/mcp-runpod-io-domain Oct 21, 2026
2 checks passed
@lukepiette
lukepiette deleted the docs/agent-setup-installer-flags branch October 21, 2026 21:13

This branch was successfully deployed

1 active deployment
staging — d958002e Deployed Oct 21, 2026 by mintlify[bot]
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.

1 participant