Repository navigation
Conversation
Surface `mint agent setup` in the site-wide markdown instructions and as an optional step in the agent setup workflow snippet. Agents are told to offer the command and to pass --agent, because without a TTY it configures every detected agent. DOC-456 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Flag the v22.20 requirement for step 9 up front in step 1, and split step 11 by publish path so logged-in users aren't sent through the claim flow. Both found by testing quickstart.md with Claude Code. DOC-456 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ethanpalm
deleted the
ethan/doc-456-add-mint-agent-setup-to-markdown-only-notes-for-agents
branch
October 31, 2026 17:27
This was referenced Oct 31, 2026
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.
Summary
Surfaces
mint agent setup(installs Mintlify skills and connects the admin MCP) in the agent-only parts of the docs. Resolves DOC-456.docs.json: adds a line tomarkdown.instructions, which renders in the Agent Instructions block at the top of every.mdpage. It tells agents to offermint agent setup --agent <claude-code|codex|cursor>rather than run it unprompted, to lower the chance agents treat it as a prompt injection.snippets/agent-setup-workflow.mdx: adds optional step 9 to the agent setup workflow (used on the quickstart and the Claude Code, Codex, and Cursor guides). It checks Node.js 22.20+ and requires--agent, because without a TTY the command configures every agent it detects. Later steps are renumbered and the step 4 cross-reference updated.The admin MCP page already has a
mint agent setupTip, so it's unchanged.Testing
mint broken-links,mint a11ypassmint dev.mdpages (mint devdoesn't serve.mdexports)--agentwhen asked to set up Mintlify fromquickstart.mdcomponents/cards.md🤖 Generated with Claude Code
Note
Low Risk
Docs and agent-instruction text only; no product code, auth, or deployment behavior changes.
Overview
Documentation-only change that tells coding agents how to offer
mint agent setupwhen helping users with Mintlify projects, instead of leaving that flow only on the admin MCP page.docs.jsonadds a new Agent Instructions line (shown on exported.mdpages) that agents should offermint agent setup --agent <claude-code|codex|cursor>in the project directory, with a link to the CLI reference. Wording emphasizes offering the command so agents are less likely to run it unprompted.snippets/agent-setup-workflow.mdx(quickstart plus Claude Code, Codex, and Cursor guides) inserts step 9: after validate/broken-links, offer to connect the user’s agent when Node.js is v22.20+, run setup with an explicit--agentflag for non-interactive terminals, and note OAuth completion in the agent. Step 1 now flags the Node version requirement; publish and post-deploy verification steps are renumbered to 10 and 11, with clearer split between logged-in Git deploys (skip claim) andmint deploy/ claim flows.Reviewed by Cursor Bugbot for commit ed902cb. Bugbot is set up for automated code reviews on this repo. Configure here.