From 9e9417bd10c1e7e98d5fae112646be3f8ecf2081 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Fri, 17 Jul 2026 16:06:01 +0000
Subject: [PATCH 1/2] docs: add copy-prompt blocks to CLI install and agent
guides
---
ai/skillmd.mdx | 9 +++++++++
cli/install.mdx | 30 ++++++++++++++++++++++++++++++
guides/claude-code.mdx | 8 ++++++++
guides/codex.mdx | 8 ++++++++
4 files changed, 55 insertions(+)
diff --git a/ai/skillmd.mdx b/ai/skillmd.mdx
index 605cd4baf0..133b9b3687 100644
--- a/ai/skillmd.mdx
+++ b/ai/skillmd.mdx
@@ -42,6 +42,15 @@ npx skills add https://your-docs-domain.com
This adds your product's capabilities to the agent's context so it can take actions on behalf of users.
+
+Install the `skill.md` files from a Mintlify-hosted documentation site into my agent context so you know what this product can do.
+
+1. Ask me for the documentation site URL if I haven't provided one, then run `npx skills add ` with that URL.
+2. Print the list of skills that were installed, including each skill's name and description.
+3. Summarize the key capabilities in one paragraph so I know what you can now help me accomplish with this product.
+4. If any skill declares required inputs or constraints in its frontmatter, call them out before I ask you to use it.
+
+
Teach your users how to use `skill.md` files with agents so that they have better results using your product with their AI tools.
diff --git a/cli/install.mdx b/cli/install.mdx
index 85df56afaf..f06eaffbf9 100644
--- a/cli/install.mdx
+++ b/cli/install.mdx
@@ -20,6 +20,19 @@ keywords: ["CLI", "npm", "install", "Node.js", "pnpm", "mint"]
```
+
+ Using an AI coding tool? Copy the following prompt to have your agent install the CLI and verify it works.
+
+
+
+Install the Mintlify CLI globally so I can preview my documentation locally.
+
+1. Confirm Node.js v20.17.0 or newer is installed by running `node --version`. If it is missing or older, tell me before continuing.
+2. Install the CLI with `npm i -g mint` (or `pnpm add -g mint` if I use pnpm).
+3. Verify the install by running `mint --version` and share the output.
+4. If the install fails with a permissions error, suggest re-running with `sudo` and explain the tradeoff.
+
+
## Create a new project
To create a new documentation project from the Mintlify starter template, run the following command:
@@ -28,6 +41,15 @@ To create a new documentation project from the Mintlify starter template, run th
mint new [directory]
```
+
+Create a new Mintlify documentation project in the current workspace.
+
+1. Ask me for a project name and preferred theme (or template) if I haven't already told you.
+2. Run `mint new --name --theme ` non-interactively, substituting the values I gave you. If I chose a template instead, run `mint new --template `.
+3. After the command finishes, list the generated files and point out `docs.json` as the main configuration entry point.
+4. Run `mint dev` from the new directory and share the local preview URL.
+
+
If you do not specify a directory, the CLI prompts you to create a new subdirectory or overwrite the current directory.
@@ -65,6 +87,14 @@ If your local preview is out of sync with your deployed documentation, update th
mint update
```
+
+Update my Mintlify CLI to the latest version.
+
+1. Try `mint update` first. If that command isn't available, fall back to `npm i -g mint@latest` (or `pnpm add -g mint@latest` for pnpm users).
+2. Verify the new version with `mint --version` and share the output.
+3. If I'm still seeing stale preview behavior after updating, remind me to delete the `~/.mintlify` cache folder and rerun `mint dev`.
+
+
If `mint update` is not available on your version, reinstall the CLI with the latest version:
diff --git a/guides/claude-code.mdx b/guides/claude-code.mdx
index c1f415f198..47d91ab53e 100644
--- a/guides/claude-code.mdx
+++ b/guides/claude-code.mdx
@@ -5,6 +5,8 @@ description: "Configure Claude Code with CLAUDE.md project instructions to write
keywords: ["Claude Code", "CLAUDE.md", "AI documentation", "Anthropic", "Claude"]
---
+import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";
+
Claude Code is an agentic command line tool that can help you maintain your documentation. It can write new content, review existing pages, and keep docs up to date.
You can train Claude Code to understand your documentation standards and workflows by adding a `CLAUDE.md` file to your project and refining it over time.
@@ -23,6 +25,12 @@ You can train Claude Code to understand your documentation standards and workflo
3. (Optional) Add the `CLAUDE.md` file below to your project.
4. Run `claude` to start.
+
+ Once Claude Code is running, paste the following prompt to load the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) into the session so Claude has full context on Mintlify components and your site's content.
+
+
+
+
## Template for CLAUDE.md
Save a `CLAUDE.md` file at the root of your docs directory to help Claude Code understand your project. This file trains Claude Code on your documentation standards, preferences, and workflows. See [Manage Claude's memory](https://docs.anthropic.com/en/docs/claude-code/memory) in the Anthropic docs for more information.
diff --git a/guides/codex.mdx b/guides/codex.mdx
index 6ed3ca1366..3025e34cf3 100644
--- a/guides/codex.mdx
+++ b/guides/codex.mdx
@@ -5,6 +5,8 @@ description: "Configure OpenAI Codex CLI with project instructions and MCP to wr
keywords: ["Codex", "OpenAI Codex", "AGENTS.md", "AI documentation", "Codex CLI"]
---
+import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";
+
Use OpenAI's Codex CLI to write and maintain Mintlify documentation from the terminal. Project instructions in `AGENTS.md` give Codex persistent context about your documentation standards, components, and style guide.
## Getting started
@@ -23,6 +25,12 @@ Use OpenAI's Codex CLI to write and maintain Mintlify documentation from the ter
See the [Codex CLI documentation](https://developers.openai.com/codex/cli) for installation alternatives and authentication options.
+
+ Once Codex is running, paste the following prompt to load the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) into the session so Codex has full context on Mintlify components and your site's content.
+
+
+
+
## Use Codex with Mintlify
Codex reads `AGENTS.md` files from your repository to understand project-specific rules and conventions before it starts working. You can place an `AGENTS.md` at the root of your docs repo to give Codex context about Mintlify components, your writing standards, and how you structure your documentation.
From 09bd05f69202426f35bac124638ae07d80c729a8 Mon Sep 17 00:00:00 2001
From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Date: Mon, 20 Jul 2026 17:35:55 -0700
Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=92=85?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
ai/skillmd.mdx | 4 ++++
cli/install.mdx | 20 ++++++++++----------
guides/claude-code.mdx | 2 +-
guides/codex.mdx | 2 +-
4 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/ai/skillmd.mdx b/ai/skillmd.mdx
index 133b9b3687..524ba12741 100644
--- a/ai/skillmd.mdx
+++ b/ai/skillmd.mdx
@@ -42,6 +42,8 @@ npx skills add https://your-docs-domain.com
This adds your product's capabilities to the agent's context so it can take actions on behalf of users.
+{/* vale off */}
+
Install the `skill.md` files from a Mintlify-hosted documentation site into my agent context so you know what this product can do.
@@ -51,6 +53,8 @@ Install the `skill.md` files from a Mintlify-hosted documentation site into my a
4. If any skill declares required inputs or constraints in its frontmatter, call them out before I ask you to use it.
+{/* vale on */}
+
Teach your users how to use `skill.md` files with agents so that they have better results using your product with their AI tools.
diff --git a/cli/install.mdx b/cli/install.mdx
index f06eaffbf9..66f13b98cb 100644
--- a/cli/install.mdx
+++ b/cli/install.mdx
@@ -24,6 +24,8 @@ keywords: ["CLI", "npm", "install", "Node.js", "pnpm", "mint"]
Using an AI coding tool? Copy the following prompt to have your agent install the CLI and verify it works.
+{/* vale off */}
+
Install the Mintlify CLI globally so I can preview my documentation locally.
@@ -33,6 +35,8 @@ Install the Mintlify CLI globally so I can preview my documentation locally.
4. If the install fails with a permissions error, suggest re-running with `sudo` and explain the tradeoff.
+{/* vale on */}
+
## Create a new project
To create a new documentation project from the Mintlify starter template, run the following command:
@@ -41,8 +45,10 @@ To create a new documentation project from the Mintlify starter template, run th
mint new [directory]
```
-
-Create a new Mintlify documentation project in the current workspace.
+{/* vale off */}
+
+
+Create a new Mintlify project in the current workspace.
1. Ask me for a project name and preferred theme (or template) if I haven't already told you.
2. Run `mint new --name --theme ` non-interactively, substituting the values I gave you. If I chose a template instead, run `mint new --template `.
@@ -50,6 +56,8 @@ Create a new Mintlify documentation project in the current workspace.
4. Run `mint dev` from the new directory and share the local preview URL.
+{/* vale on */}
+
If you do not specify a directory, the CLI prompts you to create a new subdirectory or overwrite the current directory.
@@ -87,14 +95,6 @@ If your local preview is out of sync with your deployed documentation, update th
mint update
```
-
-Update my Mintlify CLI to the latest version.
-
-1. Try `mint update` first. If that command isn't available, fall back to `npm i -g mint@latest` (or `pnpm add -g mint@latest` for pnpm users).
-2. Verify the new version with `mint --version` and share the output.
-3. If I'm still seeing stale preview behavior after updating, remind me to delete the `~/.mintlify` cache folder and rerun `mint dev`.
-
-
If `mint update` is not available on your version, reinstall the CLI with the latest version:
diff --git a/guides/claude-code.mdx b/guides/claude-code.mdx
index 47d91ab53e..867d831259 100644
--- a/guides/claude-code.mdx
+++ b/guides/claude-code.mdx
@@ -26,7 +26,7 @@ You can train Claude Code to understand your documentation standards and workflo
4. Run `claude` to start.
- Once Claude Code is running, paste the following prompt to load the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) into the session so Claude has full context on Mintlify components and your site's content.
+ Once Claude Code is running, paste the following prompt to load the Mintlify skill, [search MCP](/ai/model-context-protocol), and [admin MCP](/ai/mintlify-mcp) into the session so Claude has full context on Mintlify components and your site's content.
diff --git a/guides/codex.mdx b/guides/codex.mdx
index 3025e34cf3..5f4f1c34b2 100644
--- a/guides/codex.mdx
+++ b/guides/codex.mdx
@@ -26,7 +26,7 @@ Use OpenAI's Codex CLI to write and maintain Mintlify documentation from the ter
See the [Codex CLI documentation](https://developers.openai.com/codex/cli) for installation alternatives and authentication options.
- Once Codex is running, paste the following prompt to load the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) into the session so Codex has full context on Mintlify components and your site's content.
+ Once Codex is running, paste the following prompt to load the Mintlify [skill](/ai/skillmd), [search MCP](/ai/model-context-protocol), and [admin MCP](/ai/mintlify-mcp) into the session so Codex has full context on Mintlify components and your site's content.