# Docs

[docs.x.ai](https://docs.x.ai)

- **Overall score:** 77/100 (Grade C)
- **Checks passed:** 10 / 29
- **Last computed:** 2026-05-12

## Components

### Content Discoverability

- **Score:** 44/100 · **Status:** fail
- **Summary:** 2 failed, 2 warnings, and 1 skipped across 6 AFDocs checks.
- **Rationale:** Agents need a clear entry point and crawl map before they can reliably discover the right pages.
- **Reference:** [AFDocs reference](https://afdocs.dev)

**Checks**

- ✅ **LLMS TXT Exists** — llms.txt found at 1 location(s)
- ⚠️ **LLMS TXT Valid** — llms.txt contains parseable links but doesn't fully follow the proposed structure: https://docs.x.ai/llms.txt: No H1 heading found Your llms.txt contains parseable links but doesn't follow the standard structure. Add an H1 title as the first line and a blockquote summary (lines starting with >) to improve agent parsing.
- ❌ **LLMS TXT Size** — llms.txt is 1,034,788 characters (exceeds 100,000 threshold; will be truncated by most agents) Your llms.txt is 1,034,788 characters and will be truncated by all major agent platforms. Split into a root index linking to section-level llms.txt files, each under 50,000 characters.
- ⚠️ **LLMS TXT Links Resolve** — All links are external; 14/15 resolve (1 failed; may be bot-detection or rate-limiting) 1 of 15 links in your llms.txt return errors. Audit and fix or remove broken URLs to prevent agents from hitting dead ends.
- ⏭️ **LLMS TXT Links Markdown** — All 88 links are external; cannot assess markdown support
- ❌ **LLMS TXT Directive** — No llms.txt directive found in any of 14 sampled pages; 1 failed to fetch No agent-facing directive pointing to llms.txt was detected on any tested page. Add a blockquote near the top of each page (e.g., "> For the complete documentation index, see [llms.txt](/llms.txt)"). This can be visually hidden with CSS while remaining accessible to agents.

### Markdown Availability

- **Score:** 93/100 · **Status:** pass
- **Summary:** 2 AFDocs checks pass.
- **Rationale:** When markdown is available directly, agents spend less effort stripping presentation markup and guessing structure.
- **Reference:** [AFDocs reference](https://afdocs.dev)

**Checks**

- ✅ **Markdown Url Support** — 14/15 sampled pages support .md URLs (93%)
- ✅ **Content Negotiation** — 14/15 sampled pages support content negotiation (93%); 1 returned error pages

### Page Size and Truncation Risk

- **Score:** 79/100 · **Status:** fail
- **Summary:** 2 failed across 4 AFDocs checks.
- **Rationale:** Large pages and delayed primary content increase truncation risk and make retrieval less reliable.
- **Reference:** [AFDocs reference](https://afdocs.dev)

**Checks**

- ✅ **Rendering Strategy** — All 15 sampled pages contain server-rendered content
- ✅ **Page Size Markdown** — All 14 pages under 50K chars (median 4K, max 40K)
- ❌ **Page Size Html** — 8 of 15 sampled pages convert to over 100K chars (max 362K, 61% boilerplate) 8 of 15 pages convert to over 100K characters of markdown. Reduce inline CSS/JS, break large pages, or provide markdown versions as a smaller alternative.
- ❌ **Content Start Position** — 1 of 15 sampled pages have content starting past 50% (worst 100%) 1 of 15 pages have content starting past 50% of the converted output. Agents may never see the documentation content. Move or remove inline CSS/JS that precedes the content area.

### Content Structure

- **Score:** 100/100 · **Status:** pass
- **Summary:** 3 AFDocs checks pass.
- **Rationale:** Predictable sections, valid code fences, and serialized tabs make the content easier for agents to parse correctly.
- **Reference:** [AFDocs reference](https://afdocs.dev)

**Checks**

- ✅ **Tabbed Content Serialization** — No tabbed content detected across 15 sampled pages
- ✅ **Section Header Quality** — No tabbed content found; header quality check not applicable
- ✅ **Markdown Code Fence Validity** — All 949 code fences properly closed across 15 pages

### URL Stability and Redirects

- **Score:** 96/100 · **Status:** fail
- **Summary:** 1 failed across 2 AFDocs checks.
- **Rationale:** Stable URLs and sane redirect behavior prevent retrieval drift and broken tool references.
- **Reference:** [AFDocs reference](https://afdocs.dev)

**Checks**

- ❌ **Http Status Codes** — 1 of 15 sampled pages return 200 for non-existent URLs (soft 404) Your site returns 200 for non-existent pages (soft 404). Agents try to extract information from the error page content instead of recognizing the page is missing. Configure your server to return 404 for pages that don't exist.
- ✅ **Redirect Behavior** — No redirects detected across 15 sampled pages

### Observability and Content Health

- **Score:** 58/100 · **Status:** fail
- **Summary:** 3 failed across 3 AFDocs checks.
- **Rationale:** Coverage, parity, and cache behavior determine whether agents can trust the content they retrieve.
- **Reference:** [AFDocs reference](https://afdocs.dev)

**Checks**

- ❌ **LLMS TXT Freshness** — llms.txt covers 0/123 sitemap doc pages (0%); 123 missing; 136 llms.txt links not in sitemap (may indicate stale links or incomplete sitemap) Your llms.txt covers less than 80% of your site's pages. 123 live pages are missing from the index. Regenerate llms.txt from your sitemap or build pipeline.
- ❌ **Markdown Content Parity** — 2 of 14 pages have substantive content differences between markdown and HTML (avg 10% missing) 2 pages have substantive content differences between markdown and HTML (avg 10% missing). Agents receiving the markdown version are getting outdated or incomplete content. Regenerate markdown from source or fix the build pipeline.
- ❌ **Cache Header Hygiene** — 11 of 16 endpoints have aggressive caching or missing cache headers 11 endpoints have aggressive caching (>24h) or missing cache headers. Set max-age under 3600 or add must-revalidate with ETag/Last-Modified so content updates reach agents promptly.

### Authentication and Access

- **Score:** 100/100 · **Status:** partial
- **Summary:** 1 skipped across 2 AFDocs checks.
- **Rationale:** Agents need either public access or a clear alternative path when documentation is gated behind auth.
- **Reference:** [AFDocs reference](https://afdocs.dev)

**Checks**

- ✅ **Auth Gate Detection** — All 15 sampled pages are publicly accessible
- ⏭️ **Auth Alternative Access** — All docs pages are publicly accessible; no alternative access paths needed

### Full Content Discoverability

- **Score:** 0/100 · **Status:** fail
- **Summary:** llms-full.txt has 1 failing check.
- **Rationale:** A full-document snapshot gives long-context agents a single canonical corpus to ingest without repeated crawling.
- **Reference:** [llms-full.txt guide](https://www.mintlify.com/docs/ai/llmstxt#llms-full-txt)

**Checks**

- ❌ **LLMS Full Exists** — No llms-full.txt file was discovered.
- ⏭️ **LLMS Full Size** — Skipped because llms-full.txt was not found.
- ⏭️ **LLMS Full Valid** — Skipped because llms-full.txt was not found.
- ⏭️ **LLMS Full Links Resolve** — Skipped because llms-full.txt was not found.

### Agent Skills

- **Score:** 0/100 · **Status:** fail
- **Summary:** skill.md has 1 failing check.
- **Rationale:** Agent skills provide product-specific operating guidance that plain documentation pages do not encode on their own.
- **Reference:** [skill.md guide](https://www.mintlify.com/docs/ai/skillmd)

**Checks**

- ❌ **Skill MD** — No agent skill definition was discovered.

### MCP Server

- **Score:** 0/100 · **Status:** fail
- **Summary:** MCP has 1 failing check.
- **Rationale:** A discoverable MCP server lets agents use first-class tools instead of scraping pages and inferring behavior.
- **Reference:** [MCP guide](https://www.mintlify.com/docs/ai/model-context-protocol)

**Checks**

- ❌ **MCP Server Discoverable** — No MCP server was discovered at the expected endpoints.
- ⏭️ **MCP Tool Count** — Skipped because the MCP server was not discoverable.
