Scan Results: https://gitbook.com/docs
ID: 781bc657-21d8-40eb-8ba1-8e696bc04ae3
31/100
Agent Readiness Score
Legacy Docs (Invisible)
Invisible to AI agents. Severe context noise, non-functional code, or zero discoverable specifications.
Category Breakdown
Context Optimization11 / 30
Code Block Execution10 / 30
Machine Readability0 / 20
Agent Tooling & MCP10 / 20
Detailed Findings
⚡
Context Optimization
11/30
llms.txt Auto-Discovery
↳ AI Agent Fix Prompt
Create an llms.txt file at the root of my documentation site. Place it at: [domain]/llms.txt Structure it exactly as follows: Line 1: # [Product Name] Line 2: Blank line Line 3: One paragraph summary of what the product does and who it's for. Line 4: Blank line Line 5: ## Technical Constraints - Rate limits - Authentication requirements - SDK language support - Known limitations Line 6: Blank line Line 7: ## Key Documentation - [URL]: [one-line description] (repeat for top 10 most important pages) My docs are at: [URL] My product does: [brief description]
llms-full.txt Consolidated Docs
↳ AI Agent Fix Prompt
Create an llms-full.txt file at the root of my documentation site. This should contain the entire documentation merged into a single Markdown file.
Markdown Content Negotiation (Accept: text/markdown)
DOM Cleanliness Ratio (1% markdown/HTML)
↳ AI Agent Fix Prompt
Reduce layout boilerplate (header, footers, scripts) or use Markdown Content Negotiation to strip DOM noise.
🔧
Code Block Execution
10/30
This category was analyzed using structural heuristics. Results reflect your documentation's observable patterns.
Terminal Prompt Pollution (No "$" prefixes in copyable code)
Dependency & Import Completeness
↳ AI Agent Fix Prompt
No code blocks found to analyze.
Dynamic Variable Placeholders
↳ AI Agent Fix Prompt
No code blocks found to analyze.
🔍
Machine Readability
0/20
OpenAPI/Swagger Spec Auto-Discovery
↳ AI Agent Fix Prompt
Expose an OpenAPI or Swagger specification at a standard path (e.g. /openapi.json) or link to it using the "Link" HTTP response header with rel="openapi".
JSON-LD Structured Schema (TechArticle / APIReference / Guide)
↳ AI Agent Fix Prompt
Embed a <script type="application/ld+json"> block classifying your docs as a TechArticle, Guide, or APIReference, containing semantically enriched metadata.
🤖
Agent Tooling & MCP
10/20
Model Context Protocol (MCP) Server Integration
Error Code Diagnostics & Cross-Referencing Index
↳ AI Agent Fix Prompt
Provide a comprehensive table or section listing error codes, their causes, and solutions. This lets agents cross-reference error stacks and resolve integration errors automatically.