Repository navigation
Add an agent setup guide at /setup - #8214
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
ethanpalm
reviewed
Oct 31, 2026
| "pages": [ | ||
| "index", | ||
| "quickstart", | ||
| "setup", |
Collaborator
There was a problem hiding this comment.
since this is for agents, does it need to be in the sidebar nav? We can just have it indexed as a hidden page
…to the setup guide
Collaborator
|
@cdxker wanted to check if this is still necessary with the changes for recent agent focused CLI commands and the agent set up instructions in the quickstart |
cdxker
marked this pull request as ready for review
November 4, 2026 19:42
Contributor
Author
|
@ethanpalm I still want to have this so that we can direct agents to fetch from a public docs site if they don't have the cli already installed. I've been a bit delayed / behind on getting the full docs ready to go for this. Should be ready for a proper review by this evening |
k-finken
approved these changes
Nov 5, 2026
This was referenced Nov 5, 2026
Merged
This branch was successfully deployed
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.
Added
/setup, a guide that tells an AI agent how to connect to Mintlify from the client it's running in. It's a hidden page, so agents can fetch it but it isn't in the sidebar.clank context (clickme)
Description
The setup guide moves from mintlify.com/setup into the docs, served at /docs/setup and /docs/setup.md.
mint deploy --base, the clone,mint deploy --base --push, then the claim last. A public docs site usesmint deploy(or--github), then the claim andadd-domain.mint loginthemselves.Test Plan
mint validateandmint broken-linkspass in CI.curl https://www.mintlify.com/docs/setup.md | head.auth.md gets the same base flow in https://github.com/mintlify/server/pull/10483. The homepage prompt in https://github.com/mintlify/landing/pull/911 points agents here.
Note
Low Risk
Documentation-only addition with no runtime, auth, or application code changes.
Overview
Adds
setup.mdx, a long-form guide aimed at AI agents (not human readers) for connecting to Mintlify via MCP athttps://mcp.mintlify.com.The page splits hosted assistants (relay connector steps for Claude.ai/ChatGPT) from coding agents (configure MCP, OAuth, verify, restart). It walks through team bases vs public docs sites, including CLI flows (
deploy --base,--github, claim) when OAuth is impossible (CI, cloud sessions). Step 2 documentsmint agent setupplus per-client config for Claude Code, Cursor, Codex, Antigravity, and Grok Build, with guardrails (don't exfil-scout with curl, don't fight auto-mode blocks, preserve other MCP entries). Steps 3–5 cover pre-restart verification, user handoff for sign-in, and offering a first page viacreate_node.Per the PR description, this content moves from the landing site into the docs repo so agents can load it at
/docs/setup; related landing links are updated separately.Reviewed by Cursor Bugbot for commit bca0916. Bugbot is set up for automated code reviews on this repo. Configure here.