UPTIQ AI

Last scanned docs.uptiq.aiGitBook15 pages tested

AI agents can find, read and use these docs well. UPTIQ AI scores 98 out of 100 (grade A+), passing 20 of 26 checks. 6 still need work.

Fix it with Documentation.AI

Get this report by email

We send the full report to your inbox. Nothing on this page needs an email.

Use your work email. We only send what you asked for, and every email has an unsubscribe link.

Developer docs

Kind of site

20/26

Checks passed

5

Partly passed

1

Failed

Access

Content discoverability5 passed2 partly
  • llms.txt follows the standard structure

    llms.txt contains parseable links but doesn't fully follow the proposed structure: https://docs.uptiq.ai/llms.txt: No blockquote summary 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.

    Check your fix: llms.txt starts with a # Title, then a > summary line, then ## sections of links.

  • Pages point agents to llms.txt

    llms.txt directive found in HTML of 15 of 15 sampled pages, but buried deep in the page (past 50%)

    An llms.txt directive was found in the HTML of some pages but is missing from others, or is buried deep in the page. Ensure the directive appears near the top of every documentation page.

    Check your fix: curl -s https://docs.uptiq.ai/ai-workbench-qore/ask-assistant | grep -n llms.txt finds the link near the top of the HTML.

  • llms.txt exists

    llms.txt found at https://docs.uptiq.ai/llms.txt

  • llms.txt fits in an agent's context

    llms.txt is 44,462 characters (under 50,000 threshold)

  • llms.txt links work

    All 15 same-origin sampled links resolve (264 total links)

  • llms.txt links point to Markdown

    15/15 same-origin sampled links point to markdown content (100%)

  • Markdown pages point agents to llms.txt

    llms.txt directive found in markdown of all 15 sampled pages, near the top of content

Markdown availability2 passed
  • Pages are available as Markdown

    15/15 sampled pages support .md URLs (100%)

  • Server returns Markdown when asked

    15/15 sampled pages support content negotiation (100%)

Page size and truncation1 passed3 partly
  • Markdown pages fit in context

    1 of 15 pages between 50K–100K chars (max 53K)

    1 of 15 markdown pages are between 50K and 100K characters. These may be truncated on some agent platforms or routed through summarization. Consider splitting large pages.

  • HTML pages fit in context

    1 of 15 sampled pages convert to 50K–100K chars (max 2422K HTML → 55K markdown (99% boilerplate))

    1 of 15 pages convert to 50K-100K characters of markdown. Review pages for reducible boilerplate (navigation, serialized tabbed content). Consider providing markdown versions as a smaller alternative path for agents.

  • Content starts near the top

    5 of 15 sampled pages have content starting at 10–50% (worst 22%)

    5 of 15 pages have documentation content starting 10-50% into the converted output. Reduce navigation, breadcrumb, and sidebar markup that precedes the content area.

  • Content is in the HTML without JavaScript

    All 15 sampled pages contain server-rendered content

Content structure2 passed
  • Headings inside tabs name their variant

    2 page(s) with tabs found, but no section headers inside tab panels to evaluate

  • Tabs don't bloat the page

    2 tab group(s) across 2 of 15 sampled pages; all serialize under 50K chars

  • Code blocks are well-formed

    All 84 code fences properly closed across 16 pages

URL stability2 passed
  • Missing pages return a real 404

    All 15 sampled pages return proper error codes for bad URLs

  • Redirects stay on the same host

    No redirects detected across 15 sampled pages

Content health2 passed1 failed
  • Markdown matches the HTML page

    2 of 15 pages have substantive content differences between markdown and HTML (avg 12% missing)

    2 pages have substantive content differences between markdown and HTML (avg 12% missing). If unintentional, agents are getting outdated content; regenerate markdown from source or fix the build pipeline.

  • llms.txt covers the whole site

    llms.txt covers 99% of 264 sitemap doc pages; 3 llms.txt links not in sitemap (may indicate stale links or incomplete sitemap)

  • Cache headers allow timely updates

    All 16 endpoints have appropriate cache headers

Authentication and access1 passed
  • Gated docs offer another way in

    All docs pages are publicly accessible; no alternative access paths needed

  • Docs are readable without logging in

    All 15 sampled pages are publicly accessible

Crawler access2 passed
  • Crawlers and AI assistants may read the docs

    robots.txt lets Googlebot, Bingbot, OAI-SearchBot, PerplexityBot, Claude-SearchBot and Claude-User read the docs.

  • Sitemap lists the docs pages

    The sitemap at https://docs.uptiq.ai/sitemap.xml lists 263 of the 268 docs pages found through llms.txt and page links.

Freshness

Maintenance3 passed
  • Pages say when they were last changed

    14 of 15 sampled pages state when they were last changed, and 1 more has a date only in the sitemap.

  • Links and section anchors work

    All 30 links and 15 section anchors checked on the sampled pages work.

  • Sitemap entries still exist

    All 10 sitemap entries sampled still exist.

Consistency with the API specNot applicable
  • Endpoints in the docs exist in the API spec

    No OpenAPI description was found, so the docs could not be compared with a spec.

CurrencyNot applicable
  • Deprecated operations are marked as such

    No OpenAPI description was found, so deprecation notices could not be compared with a spec.

Additional checks

Not part of the score: optional extras that help agents use your docs.

  • MCP server is discoverable

    An MCP server is described at https://docs.uptiq.ai/.well-known/mcp/server-card.json.

  • llms-full.txt is available

    llms-full.txt found at https://docs.uptiq.ai/llms-full.txt (841,614 characters).

  • Agent skills are published

    No agent skills index was found at /.well-known/agent-skills/index.json.

    Publish an Agent Skills index at /.well-known/agent-skills/index.json with a SKILL.md for your main tasks, so agents can load task instructions without reading every page.

About this scan

Scanned
Oct 25, 2026
Pages tested
15 of 264 found
Platform
GitBook
Kind of site
Developer docs
AFDocs score, on its own
98 (A), 15 of 23 checks pass
  • Based on 15 sampled pages, chosen deterministically from the sitemap and llms.txt. Pages outside the sample were not read.
  • Pages were fetched without running JavaScript, the way most AI agents read the web.
  • Answerability, where an AI agent answers real questions written from these pages, runs in the open-source scanner with your own API key. This web score is made of Access and Freshness.

Methodology 2026-09.6 · AFDocs 0.20.0

Pages we sampled (15)
  • https://docs.uptiq.ai/ai-workbench-qore/ask-assistant
  • https://docs.uptiq.ai/ai-workbench-qore/console/agent-builder/deploy/agent-integration
  • https://docs.uptiq.ai/ai-workbench-qore/console/app-builder/build
  • https://docs.uptiq.ai/ai-workbench-qore/console/flows
  • https://docs.uptiq.ai/ai-workbench-qore/console/integrations-hub/productivity-and-collaboration
  • https://docs.uptiq.ai/ai-workbench-qore/control-center/admin/roles
  • https://docs.uptiq.ai/ai-workbench-qore/control-center/evals/evaluators
  • https://docs.uptiq.ai/ai-workbench-qore/control-center/observe/reports
  • https://docs.uptiq.ai/ai-workbench-qore/help
  • https://docs.uptiq.ai/ai-workbench-qore/release-notes/2026/january-12-2026
  • https://docs.uptiq.ai/ai-workbench-qore/start-here/how-qore-is-organized
  • https://docs.uptiq.ai/ai-workbench-qore/task-guides/use-the-console-operator
  • https://docs.uptiq.ai/document-ai/cookbooks/async-extraction-and-polling
  • https://docs.uptiq.ai/document-ai/developer-documentation/classification-1/get-classification-details
  • https://docs.uptiq.ai/document-ai/developer-documentation/getting-started/quickstart-extract-a-document

Show your score

Add the badge to your docs or README. It updates each time the site is scanned.

Agent Readiness Score badge

Markdown

[![Agent Readiness Score: 98 (A+)](https://documentation.ai/agent-score/badge/uptiq.svg)](https://documentation.ai/agent-score/uptiq)

HTML

<a href="https://documentation.ai/agent-score/uptiq"><img src="https://documentation.ai/agent-score/badge/uptiq.svg" alt="Agent Readiness Score: 98 (A+)" height="20"></a>

Agent-ready docs by default

Documentation.AI sites ship with llms.txt, Markdown pages, a sitemap and an MCP server, and our agent keeps the content current.

Live in under 5 min · No credit card required