Skip to main content

Grade how ready a website is for AI agents & LLM crawlers (llms.txt, AI-bot policy, structured data, SSR content, sitemap).

Project description

airready

PyPI License: MIT

Is your website ready for AI agents and LLM crawlers? airready grades any site on the signals that decide whether ChatGPT, Claude, Perplexity & co. can find, read, and cite it — and gives you a score, a grade, and the fixes.

pipx install mujin-airready
airready scan https://example.com
AI-readiness: https://example.com
  [----] +25 llms.txt: no /llms.txt
         → Add an /llms.txt summarizing your site for LLMs — see llmstxt.org.
  [----] +15 structured data (JSON-LD): no JSON-LD
         → Add schema.org JSON-LD so machines understand your content.
  [PASS] +8  page title: title present
  ...
  Score: 48/100  (grade D)

Gate it in CI

airready scan exits non-zero when the site falls below a bar, so a nightly job or a pre-deploy step can guard AI-readiness like any other check:

airready scan https://yoursite.com --min-grade B   # or --min-score 75

Wrapped as a GitHub Action: airready-action.

What it checks

Signal Why it matters
llms.txt The emerging standard (llmstxt.org) for telling LLMs what your site is about
AI-bot policy in robots.txt Whether you've intentionally allowed/blocked GPTBot, ClaudeBot, Google-Extended, PerplexityBot…
Structured data (JSON-LD) schema.org markup machines use to understand content
Server-rendered content Many AI crawlers don't run JavaScript — an empty SPA shell is invisible to them
sitemap.xml So crawlers find every page
title / meta description / Open Graph / canonical / h1 Core machine-readable metadata

Web tool & badge (self-hosted on Vercel)

This repo also ships the AI-Readiness Grader web tool: a URL box that grades any site and gives you an embeddable "AI-Ready" badge — paste it on your site and it links back to your full report. (/api/scan, /api/badge, index.html; deploys on Vercel zero-config; the functions are self-contained and stdlib-only, so the deploy has no dependencies.)

<a href="https://airready.mujinlabs.com/?url=YOURSITE">
  <img src="https://airready.mujinlabs.com/api/badge?grade=A&score=92" alt="AI-Ready: A">
</a>

Built by Mujin Labs — tooling for the autonomous-agent era. MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mujin_airready-0.1.1.tar.gz (70.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mujin_airready-0.1.1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file mujin_airready-0.1.1.tar.gz.

File metadata

  • Download URL: mujin_airready-0.1.1.tar.gz
  • Upload date:
  • Size: 70.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.3

File hashes

Hashes for mujin_airready-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8f244cac051e9c080c2610068b440519d757c49b3a210e128fc2ca9ae320513e
MD5 1a43c72b65b27fbe3578e1b7b271a059
BLAKE2b-256 cb979e66600734ca42951de99b4fa2ada6142a49051bfce0ce7a4874b1e32cf8

See more details on using hashes here.

File details

Details for the file mujin_airready-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: mujin_airready-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.3

File hashes

Hashes for mujin_airready-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f36a9a936c18fcb946a30b004d6aa2ddf23b8d5998a3365239ed870af8487c4d
MD5 6ca1a8dce12440a309427e40008fa3bd
BLAKE2b-256 e56ff3edb08d811012f3e51ab77b62689f2e3dd5f127b17867b6b4b3dcb4cd55

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page