Skip to content

mintlify.com/docs

Ready with a few material gaps

What should the prompt cover?

13 findings · 5 selected

Failures (7)

Warnings (6)

Task

What does mintlify.com do and who is it for? Explain it back to me.

Waiting for the agent’s first step…

Critical access needs attention

These checks describe whether an ordinary agent can enter, read, and operate the public site.

  • Agents can reach the site

    Crawler access and bot defenses.

    2 / 2 passed
  • Core content is available

    Useful content remains accessible without a fragile browser-only path.

    1 / 2 passed
  • Navigation fails safely

    Redirects and missing pages give agents a recoverable path.

    1 / 2 passed
  • Controls are understandable

    Forms and interactive controls expose usable names and structure.

    3 / 3 passed

Evaluated surfaces have material gaps

The public website is always evaluated. Optional surfaces appear when the scan finds positive evidence that they apply.

Public website

Ready with gaps

72%

10 of 18 mature checks passed

API

Needs work

50%

4 of 8 mature checks passed

Authentication

Strong

100%

3 of 3 mature checks passed

MCP

Ready with gaps

83%

0 of 1 mature checks passed

Fix these gaps first

Critical access gaps come first, followed by other applicable readiness gaps.

  1. 01

    Agent-friendly 404s

    Return a real HTTP 404 (or 410) status for nonexistent paths - never a 200 with your app shell, which makes agents believe every path exists. For full credit, give the 404 response a short markdown body pointing agents at your sitemap, llms.txt, or docs index. Verify with curl -s -o /dev/null -w "%{http_code}" https://yourdomain.com/some-path-that-does-not-exist - it must print 404.

    Critical access
  2. 02

    Content without JavaScript

    Server-side render your homepage so AI crawlers see meaningful content without JavaScript. Ensure an H1 and 500+ chars of text in raw HTML.

    Critical access
  3. 03

    OpenAPI spec published

    Publish an OpenAPI (Swagger) specification at /openapi.json or /api/openapi.yaml. This is how agents understand your API surface automatically.

    Other readiness checks
  4. 04

    Markdown content negotiation (acceptmarkdown.com)

    On the responses that serve text/markdown via Accept negotiation, add Accept to the Vary header (Vary: Accept, Accept-Encoding). Without it, CDNs can serve the cached HTML variant to an agent asking for markdown (or vice versa), depending on which variant landed in cache first.

    Other readiness checks
  5. 05

    JSON-LD structured data

    Add JSON-LD structured data to your homepage using the identity type that matches your site - SoftwareApplication for products, Organization or LocalBusiness for companies, Person for personal sites, Article for blogs - with name, description, url, and type-appropriate fields (offers, sameAs, author) so AI can parse your identity programmatically.

    Other readiness checks

Audit the checks behind the score

Applicable evidence is grouped by how it contributes to this preview model. Bonus checks appear only when they add points.

Essential7 of 11 passed · 59.4 / 80 points
  • Content without JavaScriptPartial (67%)

    3937 chars with H1 but flat heading structure

    Recommendation

    Server-side render your homepage so AI crawlers see meaningful content without JavaScript. Ensure an H1 and 500+ chars of text in raw HTML.

  • Not blocked by bot detectionPassed

    Site accessible to 6 AI agent user-agents

    Recommendation

    Allowlist known AI agent User-Agents (ChatGPT-User, ClaudeBot, Google-Extended, DeepSeekBot) in your WAF or bot-detection rules.

  • Redirect hygienePassed

    No meta-refresh stubs, JavaScript-redirect stubs, or cross-domain hops across 6 checked pages

    Recommendation

    Replace meta-refresh and JavaScript-only redirects with real HTTP 301/302 redirects. Non-JS agents never execute location.href or wait for a meta refresh - they see only the stub page. Verify with curl -sI <url> - you should see a Location header, not a 200 with a near-empty body.

  • Content behind authPassed

    All 5 sampled pages are publicly readable (5 with substantive content)

    Recommendation

    Serve your content pages without a login wall. Agents cannot complete auth flows while browsing - a 401/403 or a login-form page is invisible content. Keep public documentation public; if some content must stay gated, publish an ungated summary so agents can still represent it.

  • OpenAPI spec publishedFailed

    No OpenAPI/Swagger specification found

    Recommendation

    Publish an OpenAPI (Swagger) specification at /openapi.json or /api/openapi.yaml. This is how agents understand your API surface automatically.

  • Markdown content negotiation (acceptmarkdown.com)Failed

    Two-representation negotiation works but Vary header missing Accept (got "rsc, next-router-state-tree, next-router-prefetch, next-router-segment-prefetch, accept-encoding") - CDNs may cache wrong variant

    Recommendation

    On the responses that serve text/markdown via Accept negotiation, add Accept to the Vary header (Vary: Accept, Accept-Encoding). Without it, CDNs can serve the cached HTML variant to an agent asking for markdown (or vice versa), depending on which variant landed in cache first.

  • Agent crawler reachabilityPassed

    Reachable to all major AI crawlers - ChatGPT-User: reachable, ClaudeBot: reachable, Google-Extended: reachable, ora-agent: reachable, DeepSeekBot: reachable

    Recommendation

    Verify that major agent User-Agents can reach the homepage. If your WAF or bot rules block them, remove or narrow the blocking rule. Add an allow rule only when your security setup denies them by default.

  • OAuth 2.0 supportPassed

    OpenID Connect discovery endpoint found at https://mintlify.com

    Recommendation

    Implement OAuth 2.0 for API authentication. Publish your authorization server metadata at /.well-known/oauth-authorization-server.

  • Scoped permissionsPassed

    Scoped permissions documented at /docs

    Recommendation

    Support scoped API permissions (OAuth scopes or API key roles) so agents can request only the access they need.

  • JSON error responsesPassed

    API returns JSON error responses (401 at https://api.mintlify.com)

    Recommendation

    Return structured JSON error responses with error codes, messages, and resolution hints. Agents can't parse HTML error pages.

  • Agent-friendly 404sPartial (50%)

    Nonexistent paths return a real HTTP 404. For full credit, include a short markdown body (site map links, where to look next) so agents can recover.

    Recommendation

    Return a real HTTP 404 (or 410) status for nonexistent paths - never a 200 with your app shell, which makes agents believe every path exists. For full credit, give the 404 response a short markdown body pointing agents at your sitemap, llms.txt, or docs index. Verify with curl -s -o /dev/null -w "%{http_code}" https://yourdomain.com/some-path-that-does-not-exist - it must print 404.

Recommended10 of 19 passed · 13.3 / 20 points
  • Developer resource discoverabilityPassed

    Agent discovered 2 developer-resource types by name (developer portal, OpenAPI spec) across 5 pages

    Recommendation

    Make your developer resources (API docs, OpenAPI spec, auth docs, webhooks, MCP server) discoverable by name. Publish them at predictable URLs, list them in llms.txt, and include your product name in page titles and headings so search engines surface them for name-based queries.

  • Brand name discoverabilityPartial (67%)

    mintlify.com appears 4 times in brand-name search results for "Mintlify developer tools" (top position: #5)

    Recommendation

    Make sure a clean search for your brand name returns your own domain in the top results. If it does not, your brand may be too generic, conflict with a more established term, or not yet indexed. Strengthen brand-name search by claiming consistent NAP across listings, earning press mentions that link to the canonical domain, and avoiding redirect chains that mask the apex domain in search results.

  • Sitemap existsPassed

    Valid sitemap found at https://www.mintlify.com/sitemap.xml with 1237 entries

    Recommendation

    Add a valid XML sitemap at /sitemap.xml listing all indexable URLs. Include lastmod dates and keep it under 50MB.

  • Content efficiencyPartial (50%)

    Low content efficiency: 1.28% - most of the page is markup, not content

    Recommendation

    Reduce markup overhead so readable text is at least 5% of your HTML. Strip unused inline scripts/styles, server-render content instead of shipping large JSON hydration blobs, and keep wrapper nesting shallow.

  • JSON-LD structured dataFailed

    No JSON-LD structured data found on homepage

    Recommendation

    Add JSON-LD structured data to your homepage using the identity type that matches your site - SoftwareApplication for products, Organization or LocalBusiness for companies, Person for personal sites, Article for blogs - with name, description, url, and type-appropriate fields (offers, sameAs, author) so AI can parse your identity programmatically.

  • Public API/docs linked from homepagePassed

    Documentation site found at https://www.mintlify.com

    Recommendation

    Publish API documentation at a discoverable URL (/docs, /api, /developers). Include authentication, endpoints, and example requests.

  • Agent instruction / when-to-usePartial (67%)

    When-to-use guidance found at https://www.mintlify.com

    Recommendation

    Tell agents when to reach for you: add a 'when to use this' section to your llms.txt (or a dedicated agent-instructions file) that names your best-fit use cases and how an agent should call you. Be specific about the jobs you are right for - generic marketing copy does not read as guidance.

  • Metadata completenessPassed

    All metadata signals present: canonical URL, lang="en", og:image, og:type

    Recommendation

    Add all four signals to your homepage: , , , and . Agents use these for entity resolution and attribution.

  • Organization schema completenessFailed

    No JSON-LD found - Organization schema missing

    Recommendation

    Add Organization JSON-LD that includes both contactPoint (with email/phone and contactType) and address (PostalAddress). This lets AI verify your business legitimacy and answer contact queries.

  • Trust anchor pagesPassed

    All trust anchor pages verified: About, Contact, Privacy

    Recommendation

    Publish real /about, /contact, and /privacy pages with at least 500 characters of content each. These are the pages AI agents check to verify your business is legitimate before recommending you.

  • Page token budgetPassed

    All 7 measured pages fit an agent context budget (largest ~2K tokens)

    Recommendation

    Keep each page's extracted text under ~100K characters (~25K tokens) so it fits an agent's context window without truncation. Split oversized reference pages into focused per-topic documents and link them from an index. Check a page with curl -s <url> | wc -c and remember agents read the extracted text, not the raw HTML.

  • Code fence validityPassed

    Code fences balanced across 1 markdown document

    Recommendation

    Close every fenced code block (``` or ~~~) in your served markdown. CommonMark treats everything after an unclosed fence as code, so an agent parsing the document silently loses the rest of it. Count fence lines per file - the total must be even.

  • Developer portalPassed

    Developer portal found at /docs

    Recommendation

    Create a developer portal at /developers with API keys, documentation, quickstart guides, and a sandbox environment.

  • Public API with reachable endpointsPassed

    REST API documentation found at https://www.mintlify.com/docs/llms.txt. Best-of-protocols score: 7/7.

    Recommendation

    Expose a public REST or GraphQL API. AI agents need programmatic access - not just a web UI - to integrate with your product.

  • Agent onboarding frictionPassed

    Low friction onboarding: free tier available, self-serve key generation, sandbox/test environment, zero-auth access

    Recommendation

    Offer a free tier or trial, self-serve API key generation, and a sandbox environment. Agents can't fill out 'contact sales' forms.

  • MCP server / manifestPartial (83%)

    Live MCP server at https://mcp.mintlify.com requires authentication (OAuth challenge at initialize) - properly scoped. Upgrade to public tool listing for full 6/6.

    Recommendation

    Build an MCP (Model Context Protocol) server exposing your API as tools. Use Streamable HTTP transport for full score. This lets Claude, ChatGPT, and other AI agents call your product natively.

  • CLI tool availableFailed

    No CLI tool found

    Recommendation

    Publish an official CLI tool on npm, PyPI, or Homebrew. A CLI lets agents and developers script interactions with your product without building API integrations from scratch.

  • API schema complexity analysisFailed

    No API schema detected

    Recommendation

    Make your API spec self-describing: a unique operationId and a description on every operation, typed parameters, and response schemas. For GraphQL, a fully typed schema with a documented cost or rate limit reads best.

  • Function calling compatibilityFailed

    No API spec found - function calling requires discoverable endpoints

    Recommendation

    Ensure API endpoints have unique operation IDs, typed schemas, and descriptions compatible with LLM function-calling formats.

Bonus signals29 positive · +5 points
  • Listed in MCP registriesPassed

    Verified in npm as @mintlify/mcp via npm-scope - 50907 agent uses

    Recommendation

    Register your MCP server on Smithery (smithery.ai) or mcp.so so agent platforms can discover your tools. Link the registry entry from your homepage or docs for bi-directional verification.

  • NPM/PyPI SDK packagePassed

    NPM package found: mintlify - "The Mintlify CLI"

    Recommendation

    Publish a JavaScript/TypeScript SDK package on npm so developers can integrate your API programmatically. In package.json set repository to your source repo and homepage to your product domain - these links are how agents confirm the package is your official SDK rather than a third-party tool with a similar name.

  • Listed on skills.shPassed

    9 official skills published on skills.sh - 9,400 total installs (skills.sh/mintlify)

    Recommendation

    Publish agent skills on skills.sh so AI agents can discover your product's capabilities. Create a SKILL.md in your GitHub repo and register it with 'npx skills add'. See skills.sh/docs.

  • ChatGPT app listedPassed

    Found in ChatGPT app directory: "Mintlify MCP"

    Recommendation

    Submit your app to the ChatGPT apps / connectors directory (the apps-in-ChatGPT surface) so ChatGPT users can discover and use your product.

  • pricing.md existsPassed

    Structured pricing.md found at /pricing.md (172 lines)

    Recommendation

    Create a /pricing.md file with your pricing tiers, features, and limits in plain markdown. This lets AI agents compare costs and recommend plans without scraping HTML pricing pages.

  • MCP well-known discoveryPartial (50%)

    MCP server at https://mcp.mintlify.com - consider adding /.well-known/mcp for standard discovery

    Recommendation

    Serve your MCP server at /.well-known/mcp, publish a server-card.json at /.well-known/mcp/server-card.json, or reference it in llms.txt so agents can discover it automatically without manual URL input.

  • HTTP Link headers (RFC 8288)Passed

    RFC 8288 Link header advertises: alternate(markdown)

    Recommendation

    Add HTTP Link: response headers (RFC 8288) advertising your sitemap, markdown alternates, API service descriptions, and API catalog. Example: Link: </sitemap.xml>; rel="sitemap", </index.md>; rel="alternate"; type="text/markdown".

  • Markdown URL fallbackPartial (50%)

    Partial markdown fallback support. Homepage (https://mintlify.com/index.md) returns markdown, but 1 of 1 sampled content page do not: https://mintlify.com/docs.md. To earn full credit, serve a .md twin for each content page (e.g. /docs/auth -> /docs/auth.md) with text/markdown content-type or a heading-led non-HTML body.

    Recommendation

    Let agents fetch markdown by appending .md to page URLs. Required for any credit: serve a markdown homepage at /index.md. For full credit (2/2): also serve a .md twin for each content page (e.g. /docs/auth -> /docs/auth.md). Content-Type should be text/markdown and the body should start with a top-level heading (not HTML).

  • Modular llms.txt per product areaPassed

    Modular llms.txt files found for sections: docs, guides, customers, blog

    Recommendation

    Add per-section llms.txt files (e.g. /docs/llms.txt, /api/llms.txt, /developers/llms.txt) so agents can fetch scoped context for specific product areas instead of the whole manual.

  • Sitemap freshness (lastmod)Passed

    100% of 500 sampled sitemap entries carry lastmod; newest is 1 day(s) old

    Recommendation

    Add dates (W3C datetime, e.g. 2026-08-01) to your sitemap entries and update them when content actually changes. Aim for lastmod on at least half your entries with the newest within the last year. Verify with curl https://yourdomain.com/sitemap.xml | grep lastmod.

  • llms.txt existsPassed

    Found the llms.txt at https://www.mintlify.com/llms.txt.

    Recommendation

    Create an llms.txt file at your domain root (/llms.txt) - the AI equivalent of robots.txt. Write at least 100 characters of real content: what your product is, what it does, and links to your key docs. Then verify it with curl https://yourdomain.com/llms.txt - you should see your text, not HTML. If your app returns its homepage for every URL (common with single-page apps), add a static file route so the raw text is served. A placeholder with just a heading earns no credit.

  • llms.txt formattingPassed

    The llms.txt is well-formatted: 52 lines with markdown links, 5,312 characters in total.

    Recommendation

    Format your llms.txt as a navigation index: start with a markdown heading, include markdown links to deeper resources, and keep it under 30,000 characters. If you have more to say, move long-form content into /llms-full.txt or per-section files (e.g. /docs/llms.txt, /api/llms.txt) and link to them from the main index.

  • Skills.sh skill qualityPassed

    Rich skills.sh presence - 9 skills, 9,400 installs. Agents can understand capabilities in depth

    Recommendation

    Expand your skills.sh presence with multiple skill repos covering different use cases. Add descriptive skill names, clear SKILL.md files, and organize by capability area.

  • llms.txt links resolvePassed

    All 5 probed llms.txt links resolve to real content

    Recommendation

    Make every link your llms.txt declares resolve to real content. Verify each one with curl -L <url> - you should see the linked document, not your homepage. If your app returns the homepage shell for unknown paths (common with single-page apps), a 200 status is not proof: check the body. Fix or remove any dead link; agents that follow the index treat a broken link as a dead end.

  • Markdown alternate linkPassed

    Markdown alternate advertised and verified: https://www.mintlify.com/index.md serves markdown

    Recommendation

    Advertise a markdown twin of each page with in the HTML head (or an equivalent Link response header), and make sure the advertised URL actually serves markdown - an advertisement pointing at HTML is worse than none. Verify the target with curl -s <href> and check the body starts with a heading, not .

  • Markdown agent docsPassed

    Path-suffix markdown docs served with text/markdown content-type: /index.md

    Recommendation

    Pick one: (a) return Content-Type: text/markdown on GET when the request sends Accept: text/markdown, or (b) publish a static /llms.md, /auth.md, or /agents.md file at your root with real markdown content. Option (b) is usually a single static file. This is the cold-discovery path for agents that land at your homepage from web search without reading llms.txt first.

  • MCP auth mechanismPassed

    product MCP requires authentication with OAuth metadata discovery

    Recommendation

    Protect your MCP server with OAuth 2.0 authentication. Publish authorization server metadata at /.well-known/oauth-authorization-server for automatic agent auth flows.

  • MCP OAuth metadataPassed

    RFC 8414 OAuth metadata for product MCP: issuer=https://mcp.mintlify.com, auth and token endpoints present

    Recommendation

    Publish RFC 8414 authorization server metadata with issuer, authorization_endpoint, and token_endpoint so agents can authenticate without hardcoded URLs.

  • MCP PKCE S256 supportPassed

    OAuth metadata for product MCP supports PKCE S256 code challenge

    Recommendation

    Support PKCE with S256 code challenge method in your OAuth server. Add 'S256' to code_challenge_methods_supported in your authorization server metadata.

  • OAuth Protected Resource metadata (RFC 9728)Passed

    RFC 9728 metadata: resource=https://mcp.mintlify.com, authorization_servers (1), scopes_supported (13), bearer_methods_supported

    Recommendation

    Publish RFC 9728 protected-resource metadata at /.well-known/oauth-protected-resource. Include the resource field plus enough supporting metadata - your authorization servers, supported scopes, accepted bearer methods - that an agent can work out how to authenticate without first triggering a 401.

  • Agent auth discovery metadataPartial (33%)

    PRM + AS metadata both present (AS metadata fetched from advertised origin https://mcp.mintlify.com) but AS metadata has no agent_auth block

    Recommendation

    Publish RFC 9728 protected-resource metadata at /.well-known/oauth-protected-resource on your resource server (the host that actually serves the API, e.g. api.) with resource and authorization_servers. Publish RFC 8414 authorization-server metadata at /.well-known/oauth-authorization-server on the AS origin, and include the WorkOS auth.md agent_auth block with register_uri, identity_types_supported drawn from the spec enum (anonymous, identity_assertion - variants like verified_email or urn:ietf:params:oauth:token-type:id-jag belong inside identity_assertion.assertion_types_supported, not at the top level), and a sibling per-type block for each advertised type (anonymous.credential_types_supported; identity_assertion.assertion_types_supported + credential_types_supported) so agents can look up the request shape. Cross-link by listing the AS origin in PRM authorization_servers, and point agent_auth.skill back at your published /auth.md. Spec: https://workos.com/auth-md.

  • Agent auth WWW-Authenticate hintPassed

    401 at https://mcp.mintlify.com at / with spec-shaped WWW-Authenticate hint: Bearer resource_metadata="https://mcp.mintlify.com/.well-known/oauth-protected-resource"

    Recommendation

    Return a 401 carrying a spec-shaped WWW-Authenticate: Bearer resource_metadata="<your protected-resource metadata URL>" header on your API's primary entry points, so an agent learns your auth requirements from one request instead of hunting for the well-known document. Point the metadata URL at /.well-known/oauth-protected-resource on the host that serves the API. Spec: https://workos.com/auth-md.

  • WebMCP supportPartial (50%)

    WebMCP mentioned in documentation at /docs but not implemented on homepage

    Recommendation

    Expose in-page tools via WebMCP, the W3C draft standard for browser-resident AI agents. Add toolname and tooldescription attributes to your action forms - they survive into server-rendered HTML, so scanners and agents can see them - and register richer tools from client-side JS with document.modelContext.registerTool() (navigator.modelContext is the deprecated pre-Chrome-150 alias). Chrome ships WebMCP in 157 after the 149-156 origin trial.

  • Multi-language SDK packagesPartial (33%)

    SDK package found only in npm

    Recommendation

    Publish official SDK packages across multiple language ecosystems (npm, PyPI, Go modules, RubyGems). Auto-generate them from your OpenAPI spec using tools like openapi-generator. For each package set the project URL or homepage to your product domain (package.json repository/homepage, PyPI Home-Page or project_urls, RubyGems homepage_uri) - this is how agents verify the package is your official SDK.

  • Accessible document structurePassed

    Server HTML is a well-structured document (main=true, landmarks=4/4, h1=1, maxHeadingSkip=1).

  • Native interactive controlsPassed

    85 native controls, 1 non-native div-soup affordances (99% native).

  • Accessible names on controlsPassed

    85/85 interactive elements have a computable accessible name (100%).

  • Accessibility-tree injection safety (bonus)Passed

    No hidden instruction text detected in accessibility-tree attributes or off-screen content.

  • A2UI / generative UI supportPassed

    A2UI/generative UI references found at /docs (ui component)

    Recommendation

    Support Agent-to-UI rendering via MCP Apps (ui:// resources), OpenAI Apps SDK, or generative UI patterns that let agents render interactive UIs in conversation.

Inspect the underlying audit

The complete Ora audit uses evidence from the scan on . After applying changes, run another scan from the homepage to refresh these recommendations.

Sign me up for Vercel product updates and marketing emails.

Unsubscribe anytime. Privacy Notice

Source: Ora API

Snapshot 2026-08-21T20-16-29-065Z