docs: add agent setup prompt for one-shot skills + MCP install - #740
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
camopod
marked this pull request as ready for review
July 28, 2026 20:52
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
force-pushed
the
cameronmcclendon/con-831-agent-setup-prompt
branch
from
July 29, 2026 16:15
71b365b to
6ab9d0b
Compare
lavanya-gunreddi
approved these changes
Jul 29, 2026
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
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
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.jsonis 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.mdThe page is intentionally unlisted — it's absent from
docs.json, so it stays out of the sidebar, search, sitemap, andllms.txt. It's reached through the console's "onboard your agent" link, not by browsing the docs. This mirrors Cloudflare, where/agent-setup/promptreturns 404 and only the.mdresolves.Consumed by main-ui #4541, which copies this URL to the user's clipboard.
Contents
Covers both MCP servers —
runpod(hosted, OAuth) andrunpod-docs(public) — plus the skills plugin andrunpodctl, with routes for Claude Code, Codex, Cursor, GitHub Copilot, Windsurf, Cline, opencode, and Gemini. Every command comes from the official plugin reporunpod/runpod-plugins-official.Verified
Ran the Claude Code path end-to-end in Claude Code v2.1.178:
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.mdreturns200 text/markdown, is absent fromllms.txt, and no existing page's indexing changed.Notes for review
.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./agent-setupfor 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.sidebarTitleortagin the frontmatter, since neither does anything for an unlisted page.Related: CON-831