Skip to content

Commit c42d693

Browse files
Document agent readiness checks for mint score (#5346)
* Document agent readiness checks including new structured data check Generated-By: mintlify-agent * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent 20699dd commit c42d693

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

cli/commands.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,34 @@ mint score <url> [flags]
290290

291291
The command displays an overall readiness score and a breakdown of individual checks with pass/fail indicators.
292292

293+
### Checks
294+
295+
The score evaluates the following areas:
296+
297+
| Check | What it verifies |
298+
| --- | --- |
299+
| `llmsTxtExists` | Agents can reach an [llms.txt](/ai/llmstxt) file at the site root. |
300+
| `llmsTxtValid` | The `llms.txt` file follows the expected format with headings, blockquote summary, and Markdown links. |
301+
| `llmsTxtSize` | The `llms.txt` file is within the size threshold so agents can consume it without truncation. |
302+
| `llmsTxtLinksResolve` | Links inside `llms.txt` resolve to live pages. |
303+
| `llmsTxtLinksMarkdown` | Links inside `llms.txt` use Markdown syntax. |
304+
| `llmsTxtDirective` | The `llms.txt` file contains usage directives. |
305+
| `llmsTxtFullExists` | An [llms-full.txt](/ai/llmstxt/#llms-full-txt) file is available for agents that need the complete content. |
306+
| `llmsTxtFullSize` | The `llms-full.txt` file is within a reasonable size for agents to process. |
307+
| `llmsTxtFullValid` | The `llms-full.txt` file contains valid content with headings. |
308+
| `llmsTxtFullLinksResolve` | Links inside `llms-full.txt` resolve to live pages. |
309+
| `skillMd` | Agents can reach a [skill.md](https://www.mintlify.com/docs/ai/skillmd) file for agent tool use. |
310+
| `contentNegotiationMarkdown` | The site returns Markdown when agents request it through content negotiation. |
311+
| `contentNegotiationPlaintext` | The site returns plain text when agents request it through content negotiation. |
312+
| `mcpServerDiscoverable` | Agents can discover an [MCP server](/ai/model-context-protocol) for tool-based agents. |
313+
| `mcpToolCount` | The MCP server exposes at least one tool. |
314+
| `openApiSpec` | There is an available OpenAPI or Swagger specification at a standard path. |
315+
| `robotsTxtAllowsAI` | The `robots.txt` file does not block AI crawlers. |
316+
| `sitemapExists` | There is a sitemap available for page discovery. |
317+
| `structuredData` | The homepage contains [JSON-LD](https://json-ld.org/) structured data (`<script type="application/ld+json">`). Reports the number of JSON-LD blocks and the schema types found. |
318+
319+
Child checks only run when their parent check passes. For example, `llmsTxtValid` only runs if `llmsTxtExists` passes first.
320+
293321
---
294322

295323
## `mint new`

0 commit comments

Comments
 (0)