Skip to content

docs: add agent setup prompt for one-shot skills + MCP install - #740

Merged
camopod merged 1 commit into
mainfrom
cameronmcclendon/con-831-agent-setup-prompt
Jul 29, 2026
Merged

docs: add agent setup prompt for one-shot skills + MCP install#740
camopod merged 1 commit into
mainfrom
cameronmcclendon/con-831-agent-setup-prompt

Conversation

@camopod

@camopod camopod commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds agent-setup.mdx — an agent-runnable setup document. A user copies one line into their coding agent, the agent fetches this file and installs the Runpod skills, MCP server, and CLI itself, with no per-client hunting through docs.

Modeled on Cloudflare's agent-setup/prompt.md.

Changes exactly one file. Nothing existing is touched — docs.json is unmodified, so the sidebar, search, and every current page stay as they are.

Where it publishes

Because Mintlify serves a markdown version of every page, this lands at:

https://docs.runpod.io/agent-setup.md

The page is intentionally unlisted — it's absent from docs.json, so it stays out of the sidebar, search, sitemap, and llms.txt. It's reached through the console's "onboard your agent" link, not by browsing the docs. This mirrors Cloudflare, where /agent-setup/prompt returns 404 and only the .md resolves.

Consumed by main-ui #4541, which copies this URL to the user's clipboard.

Contents

Covers both MCP servers — runpod (hosted, OAuth) and runpod-docs (public) — plus the skills plugin and runpodctl, with routes for Claude Code, Codex, Cursor, GitHub Copilot, Windsurf, Cline, opencode, and Gemini. Every command comes from the official plugin repo runpod/runpod-plugins-official.

Verified

Ran the Claude Code path end-to-end in Claude Code v2.1.178:

$ claude plugin marketplace add runpod/runpod-plugins-official
✔ Successfully added marketplace: runpod

$ claude plugin install runpod@runpod
✔ Successfully installed plugin: runpod@runpod (scope: user)

$ claude mcp list
plugin:runpod:runpod: https://mcp.getrunpod.io/ (HTTP) - ✔ Connected

All six skills installed, and the plugin auto-wires the hosted MCP server as the doc claims — no separate MCP setup needed. OAuth sign-in completed successfully.

On the preview: /agent-setup.md returns 200 text/markdown, is absent from llms.txt, and no existing page's indexing changed.

Notes for review

  • The Codex route is untested — I don't have Codex installed. Those commands come from the plugin repo's README rather than firsthand verification. Happy to hold for a tester if you'd rather not publish unverified steps.
  • Mintlify prepends a preamble to the served .md (its documentation-index blockquote, then the frontmatter title and description). Harmless for an agent, but it means the file isn't byte-identical to Cloudflare's raw version. Flagging in case you want the frontmatter shaped differently.
  • The HTML route still resolves at /agent-setup for anyone with the URL, since Mintlify renders every page. Unlisted and unindexed, but not absent — unlike Cloudflare's, which 404s. Open to other approaches if that matters.
  • No sidebarTitle or tag in the frontmatter, since neither does anything for an unlisted page.
  • Vale isn't installed locally, so style nits may need a pass.

Related: CON-831

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Jul 28, 2026, 8:05 PM

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

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
runpod-docs 🟡 Building Jul 28, 2026, 8:03 PM

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

Adds an unlisted agent-runnable setup document at agent-setup.mdx, published as
markdown at docs.runpod.io/agent-setup.md. Pointing a coding agent at that URL
installs the Runpod skills, hosted MCP server, and CLI in one pass, with routes
for Claude Code, Codex, Cursor, GitHub Copilot, Windsurf, Cline, opencode, and
Gemini.

The page is deliberately left out of docs.json so it stays out of the sidebar,
search, and sitemap — it is reached from the console's "onboard your agent"
link rather than by browsing the docs.
@camopod
camopod force-pushed the cameronmcclendon/con-831-agent-setup-prompt branch from 71b365b to 6ab9d0b Compare July 29, 2026 16:15
@camopod
camopod merged commit 42e3dbd into main Jul 29, 2026
3 checks passed
@camopod
camopod deleted the cameronmcclendon/con-831-agent-setup-prompt branch July 29, 2026 19:16
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