Skip to content

Add an agent setup guide at /setup - #8214

Merged
cdxker merged 13 commits into
mainfrom
denzell/agent-setup-guide
Nov 5, 2026
Merged

cdxker merged 13 commits into
mainfrom
denzell/agent-setup-guide

Conversation

@cdxker

@cdxker cdxker commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

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.

  • Hosted assistants relay the connector steps. Coding agents ask whether the person wants a base or a public docs site.
  • A new base goes through mint deploy --base, the clone, mint deploy --base --push, then the claim last. A public docs site uses mint deploy (or --github), then the claim and add-domain.
  • Then per-client MCP config for Claude Code, Cursor, Codex, Antigravity and Grok Build, the restart handoff, and a first page. Agents keep messages to the person short and never run mint login themselves.

Test Plan

  • mint validate and mint broken-links pass in CI.
  • After deploy: 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 at https://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 documents mint agent setup plus 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 via create_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.

@mintlify

mintlify Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Nov 5, 2026, 2:10 AM

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

Comment thread docs.json Outdated
"pages": [
"index",
"quickstart",
"setup",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is for agents, does it need to be in the sidebar nav? We can just have it indexed as a hidden page

@ethanpalm

Copy link
Copy Markdown
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
cdxker marked this pull request as ready for review November 4, 2026 19:42
@cdxker

cdxker commented Nov 4, 2026

Copy link
Copy Markdown
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

@cdxker
cdxker merged commit 90d8e4d into main Nov 5, 2026
5 checks passed
@cdxker
cdxker deleted the denzell/agent-setup-guide branch November 5, 2026 02:17

This branch was successfully deployed

1 active deployment
staging — 951ff8bb Deployed Nov 5, 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.

3 participants