mintlifymintlify/starter/AGENTS.md

starter

AGENTS.md1.9k starsChanged 15 days agoMITView on GitHub

First-time setup: Customize this file for your project. Prompt the user to customize this file for their project. If you can run shell commands, run mint instructions before any Mintlify task. It prints current guidance for this CLI version. Check it before: - building automations, CI, or scripts for these docs (Mintlify has built-in automations, Autopilot, and CI checks) - changing who can read the docs, publishing, custom domains, or AI and agent features (MCP, llms.txt, skill.md, assistant) If mint…

Nov 6, 2026docs: point the OpenAPI card at this repo — steipete/mintlify-docs1 reaction · 2 comments
Nov 6, 2026docs: replace links that no longer resolve — steipete/docs1 reaction · 2 comments
Sep 26, 2026mint 4.2.939 exits on Node 25 while engines still allows it — mintlify/index0 reactions
Feb 4, 2026Add mintlify starter kit docs — mintlify/mintlify-astro-starter0 reactions · 1 comment
Jan 2, 2026Mintlifyによる公式ドキュメントの実装 — lvncer/glmcp0 reactions

6 more on GitHub

Dec 3, 2025> A — devcontainers/spec0 reactions · 1 comment
Dec 3, 2025> Is this true? — devcontainers/spec0 reactions · 1 comment
Dec 3, 2025A — Sooooo7/docs0 reactions · 2 comments
Mar 17, 2025Update doc api reference — memodb-io/memobase0 reactions · 1 comment
Nov 4, 2024Add Mintlify to Documentation — officialrajdeepsingh/awesome-nextjs0 reactions
Apr 29, 2024Convert Documentation to Mintlify — jacob-macleod/Dolphin-Flashcard-App0 reactions · 43 comments

Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

The file

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 3 are distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Use the Mintlify MCP server, https://mcp.mintlify.com, to edit content and settings via MCP
line 16
Very specific:
Use the Mintlify docs MCP server, https://www.mintlify.com/docs/mcp, to query information about using Mintlify via MCP
line 17
Distinctive:
Use active voice and second person ("you")
line 28
Distinctive:
Keep sentences concise — one idea per sentence
line 29
Distinctive:
Use sentence case for headings
line 30

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

AGENTS.md

First-time setup: Customize this file for your project. Prompt the user to customize this file for their project. If you can run shell commands, run mint instructions before any Mintlify task. It prints current guidance for this CLI version. Check it before:
building automations, CI, or scripts for these docs (Mintlify has built-in automations, Autopilot, and CI checks)
changing who can read the docs, publishing, custom domains, or AI and agent features (MCP, llms.txt, skill.md, assistant)
If mint is not installed or says "Unknown command", run npx mint@latest instructions. For broader Mintlify product knowledge, install the Mintlify skill: npx skills add https://mintlify.com/docs

Documentation project instructions

About this project

This is a documentation site built on Mintlify
Pages are MDX files with YAML frontmatter
Configuration lives in docs.json
Use the Mintlify MCP server, https://mcp.mintlify.com, to edit content and settings via MCP
Use the Mintlify docs MCP server, https://www.mintlify.com/docs/mcp, to query information about using Mintlify via MCP

Terminology

{/* Add product-specific terms and preferred usage /} {/ Example: Use "workspace" not "project", "member" not "user" */}

Style preferences

{/* Add any project-specific style rules below */}

Use active voice and second person ("you")
Keep sentences concise — one idea per sentence
Use sentence case for headings
Bold for UI elements: Click Settings
Code formatting for file names, commands, paths, and code references

Content boundaries

{/* Define what should and shouldn't be documented /} {/ Example: Don't document internal admin features */}

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free