INDEXABLE LLM READINESS REPORT

LLMs.txt Validator Report for github.com

AI discoverability, crawler accessibility, llms.txt structure, and LLM readiness signals for github.com.

Report Summary

Source checked: https://github.com/llms.txt

Checked at 2026-06-04T20:53:57.395Z.

Parsed Preview

Title, sections, documentation links, API references, and resources extracted from llms.txt.

Title

GitHub

> GitHub is a developer platform for building, shipping, and maintaining software. It provides cloud-based Git repository hosting, CI/CD via GitHub Actions, project management with Issues and Projects, code review via pull requests, AI-powered development w...

Sections

12
How to use10 links
Building with GitHub, for coding agents and automation10 links
GitHub Copilot24 links
Get started15 links
Authentication12 links
GitHub Pages10 links
Account and profile8 links
Repositories7 links
Apps5 links
GitHub Actions3 links
Pull requests3 links
More pages13 links

Contact

[Individual plans](https://docs.github.com/en/copilot/concepts/billing/individual-plans): GitHub offers several Copilot plans for individual developers, each with different features, model access, and usage limits to support a wide range of coding needs.

Improve AI Discoverability

Turn llms.txt into infrastructure for AI assistants, AI search engines, and LLM-powered crawlers.

Publish llms.txt at site root
Link documentation
Link APIs
Link support resources
Add structured metadata
Add Agent Card
Add OpenAPI schema
Launch Agent Runtime

AI Readiness Score

65/ 100
Basic
65
llms.txt
structure
docs
APIs
resources
contact
robots.txt
sitemap
JSON-LD
Agent Card
OpenAPI

Recommendations

Prioritized fixes for AI search visibility, crawler accessibility, and LLM readiness.

6
  • About section missing

    Structure

    Add a ## About section to help AI systems navigate your site.

  • Documentation section missing

    Structure

    Add a ## Documentation section to help AI systems navigate your site.

  • APIs section missing

    Structure

    Add a ## APIs section to help AI systems navigate your site.

  • Resources section missing

    Structure

    Add a ## Resources section to help AI systems navigate your site.

  • Contact section missing

    Structure

    Add a ## Contact section to help AI systems navigate your site.

  • Linked URL may not be reachable

    Links

    Update the link or make the destination publicly accessible.

Validation Results

Availability, format, structure, links, discoverability, and AI readiness checks.

HTTP 200

Errors

0

None.

Warnings

17
  • About section missing

    Structure## About

    The recommended ## About section was not found.

    Suggested fix: Add a ## About section to help AI systems navigate your site.

  • Documentation section missing

    Structure## Documentation

    The recommended ## Documentation section was not found.

    Suggested fix: Add a ## Documentation section to help AI systems navigate your site.

  • APIs section missing

    Structure## APIs

    The recommended ## APIs section was not found.

    Suggested fix: Add a ## APIs section to help AI systems navigate your site.

  • Resources section missing

    Structure## Resources

    The recommended ## Resources section was not found.

    Suggested fix: Add a ## Resources section to help AI systems navigate your site.

  • Linked URL may not be reachable

    Linksline 9

    https://docs.github.com/api/pagelist/versions):: HTTP 400

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 10

    https://docs.github.com/api/pagelist/languages):: HTTP 400

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 11

    https://docs.github.com/api/pagelist/en/free-pro-team@latest):: HTTP 400

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 12

    https://docs.github.com/api/article):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 13

    https://docs.github.com/api/article/body):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 14

    https://docs.github.com/api/search/v1):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 15

    https://github.com/github/github-mcp-server):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 19

    https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 20

    https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 21

    https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 22

    https://docs.github.com/en/copilot/concepts/agents/cloud-agent/about-cloud-agent):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 23

    https://docs.github.com/en/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents-in-your-ide):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

  • Linked URL may not be reachable

    Linksline 24

    https://docs.github.com/en/github-cli/github-cli):: HTTP 404

    Suggested fix: Update the link or make the destination publicly accessible.

Recommendations

5
  • Contact section missing

    Structure## Contact

    The recommended ## Contact section was not found.

    Suggested fix: Add a ## Contact section to help AI systems navigate your site.

  • sitemap.xml not detected

    AI Readiness

    No public sitemap.xml signal was found.

    Suggested fix: Publish /sitemap.xml and reference important documentation pages.

  • JSON-LD not detected

    AI Readiness

    No structured metadata was detected on the homepage.

    Suggested fix: Add JSON-LD Organization, WebSite, SoftwareApplication, or Product metadata.

  • Agent Card not detected

    AI Readiness

    No Agent Card discovery file was detected.

    Suggested fix: Publish /.well-known/agent-card.json for agent-native discovery.

  • OpenAPI schema not detected

    AI Readiness

    No OpenAPI or Swagger schema was found in llms.txt or common schema paths.

    Suggested fix: Add an OpenAPI schema URL under ## APIs.

Success checks

140
  • llms.txt URL checked

    AvailabilitysourceUrl

    Checked https://github.com/llms.txt.

  • HTTP 200 returned

    Availabilityhttp.status

    The llms.txt endpoint is available to crawlers.

  • HTTPS enabled

    AvailabilitysourceUrl

    The llms.txt endpoint is served over HTTPS.

  • No redirect required

    Availabilityhttp.redirectCount

    The llms.txt endpoint was reached directly.

  • Fast response time

    Availabilityhttp.responseTimeMs

    The endpoint responded in 474ms.

  • Plain text response

    Formathttp.contentType

    Content-Type is text/plain.

  • UTF-8 compatible

    Formatencoding

    The file is readable as UTF-8 text.

  • Reasonable file size

    Formatfile.size

    The file size is within the recommended 256KB envelope.

  • Line endings are valid

    FormatlineEndings

    Line endings are consistent and parser-friendly.

  • Title detected

    Structure# title

    The file declares "GitHub".

  • Links detected

    Links

    120 URLs found in llms.txt.

  • URL format valid

    Linksline 9

    https://docs.github.com/api/pagelist/versions):

  • URL format valid

    Linksline 10

    https://docs.github.com/api/pagelist/languages):

  • URL format valid

    Linksline 11

    https://docs.github.com/api/pagelist/en/free-pro-team@latest):

  • URL format valid

    Linksline 12

    https://docs.github.com/api/article):

  • URL format valid

    Linksline 12

    https://docs.github.com/api/article?pathname=/en/get-started/start-your-journey/about-github-and-git

  • Linked URL reachable

    Linksline 12

    https://docs.github.com/api/article?pathname=/en/get-started/start-your-journey/about-github-and-git returned HTTP 200.

  • URL format valid

    Linksline 13

    https://docs.github.com/api/article/body):

  • URL format valid

    Linksline 13

    https://docs.github.com/api/article/body?pathname=/en/get-started/start-your-journey/about-github-and-git

  • Linked URL reachable

    Linksline 13

    https://docs.github.com/api/article/body?pathname=/en/get-started/start-your-journey/about-github-and-git returned HTTP 200.

  • URL format valid

    Linksline 14

    https://docs.github.com/api/search/v1):

  • URL format valid

    Linksline 14

    https://docs.github.com/api/search/v1?query=actions&language=en&version=free-pro-team@latest

  • Linked URL reachable

    Linksline 14

    https://docs.github.com/api/search/v1?query=actions&language=en&version=free-pro-team@latest returned HTTP 200.

  • URL format valid

    Linksline 15

    https://github.com/github/github-mcp-server):

  • URL format valid

    Linksline 19

    https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp):

  • URL format valid

    Linksline 20

    https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server):

  • URL format valid

    Linksline 21

    https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server):

  • URL format valid

    Linksline 22

    https://docs.github.com/en/copilot/concepts/agents/cloud-agent/about-cloud-agent):

  • URL format valid

    Linksline 23

    https://docs.github.com/en/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents-in-your-ide):

  • URL format valid

    Linksline 24

    https://docs.github.com/en/github-cli/github-cli):

  • URL format valid

    Linksline 25

    https://docs.github.com/en/github-cli/github-cli/quickstart):

  • URL format valid

    Linksline 26

    https://docs.github.com/en/rest):

  • URL format valid

    Linksline 27

    https://docs.github.com/en/graphql):

  • URL format valid

    Linksline 28

    https://docs.github.com/en/actions):

  • URL format valid

    Linksline 34

    https://docs.github.com/en/copilot):

  • URL format valid

    Linksline 35

    https://docs.github.com/en/copilot/concepts/billing/copilot-requests):

  • URL format valid

    Linksline 36

    https://docs.github.com/en/copilot/concepts/billing/individual-plans):

  • URL format valid

    Linksline 37

    https://docs.github.com/en/copilot/concepts/billing/usage-based-billing-for-individuals):

  • URL format valid

    Linksline 38

    https://docs.github.com/en/copilot/concepts/billing/usage-based-billing-for-organizations-and-enterprises):

  • URL format valid

    Linksline 39

    https://docs.github.com/en/copilot/concepts/usage-limits):

  • URL format valid

    Linksline 40

    https://docs.github.com/en/copilot/get-started/features):

  • URL format valid

    Linksline 41

    https://docs.github.com/en/copilot/get-started/plans):

  • URL format valid

    Linksline 42

    https://docs.github.com/en/copilot/get-started/quickstart):

  • URL format valid

    Linksline 43

    https://docs.github.com/en/copilot/get-started/what-is-github-copilot):

  • URL format valid

    Linksline 44

    https://docs.github.com/en/copilot/how-tos/copilot-cli/cli-best-practices):

  • URL format valid

    Linksline 45

    https://docs.github.com/en/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli):

  • URL format valid

    Linksline 46

    https://docs.github.com/en/copilot/how-tos/copilot-cli/use-copilot-cli/overview):

  • URL format valid

    Linksline 47

    https://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions):

  • URL format valid

    Linksline 48

    https://docs.github.com/en/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students):

  • URL format valid

    Linksline 49

    https://docs.github.com/en/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions):

  • URL format valid

    Linksline 50

    https://docs.github.com/en/copilot/how-tos/manage-and-track-spending/prepare-for-your-move-to-usage-based-billing):

  • URL format valid

    Linksline 51

    https://docs.github.com/en/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues):

  • URL format valid

    Linksline 52

    https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review):

  • URL format valid

    Linksline 53

    https://docs.github.com/en/copilot/reference/ai-models/supported-models):

  • URL format valid

    Linksline 54

    https://docs.github.com/en/copilot/reference/copilot-billing/models-and-pricing):

  • URL format valid

    Linksline 55

    https://docs.github.com/en/copilot/responsible-use/chat-in-github):

  • URL format valid

    Linksline 56

    https://docs.github.com/en/copilot/responsible-use/chat-in-github-mobile):

  • URL format valid

    Linksline 57

    https://docs.github.com/en/copilot/tutorials/copilot-cookbook):

  • URL format valid

    Linksline 63

    https://docs.github.com/en/get-started):

  • URL format valid

    Linksline 64

    https://docs.github.com/en/get-started/git-basics/about-remote-repositories):

  • URL format valid

    Linksline 65

    https://docs.github.com/en/get-started/git-basics/ignoring-files):

  • URL format valid

    Linksline 66

    https://docs.github.com/en/get-started/git-basics/managing-remote-repositories):

  • URL format valid

    Linksline 67

    https://docs.github.com/en/get-started/git-basics/set-up-git):

  • URL format valid

    Linksline 68

    https://docs.github.com/en/get-started/learning-about-github/githubs-plans):

  • URL format valid

    Linksline 69

    https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts):

  • URL format valid

    Linksline 70

    https://docs.github.com/en/get-started/start-your-journey):

  • URL format valid

    Linksline 71

    https://docs.github.com/en/get-started/start-your-journey/about-github-and-git):

  • URL format valid

    Linksline 72

    https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github):

  • URL format valid

    Linksline 73

    https://docs.github.com/en/get-started/start-your-journey/downloading-files-from-github):

  • URL format valid

    Linksline 74

    https://docs.github.com/en/get-started/start-your-journey/hello-world):

  • URL format valid

    Linksline 75

    https://docs.github.com/en/get-started/using-github-docs/about-versions-of-github-docs):

  • URL format valid

    Linksline 76

    https://docs.github.com/en/get-started/using-github/troubleshooting-connectivity-problems):

  • URL format valid

    Linksline 77

    https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax):

  • URL format valid

    Linksline 83

    https://docs.github.com/en/authentication/connecting-to-github-with-ssh):

  • URL format valid

    Linksline 84

    https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account):

  • URL format valid

    Linksline 85

    https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys):

  • URL format valid

    Linksline 86

    https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent):

  • URL format valid

    Linksline 87

    https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys):

  • URL format valid

    Linksline 88

    https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection):

  • URL format valid

    Linksline 89

    https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github):

  • URL format valid

    Linksline 90

    https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens):

  • URL format valid

    Linksline 91

    https://docs.github.com/en/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits):

  • URL format valid

    Linksline 92

    https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication):

  • URL format valid

    Linksline 93

    https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods):

  • URL format valid

    Linksline 94

    https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials):

  • URL format valid

    Linksline 100

    https://docs.github.com/en/pages):

  • URL format valid

    Linksline 101

    https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site):

  • URL format valid

    Linksline 102

    https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages):

  • URL format valid

    Linksline 103

    https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site):

  • URL format valid

    Linksline 104

    https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site):

  • URL format valid

    Linksline 105

    https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site):

  • URL format valid

    Linksline 106

    https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages):

  • URL format valid

    Linksline 107

    https://docs.github.com/en/pages/quickstart):

  • URL format valid

    Linksline 108

    https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll):

  • URL format valid

    Linksline 109

    https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll):

  • URL format valid

    Linksline 115

    https://docs.github.com/en/account-and-profile):

  • URL format valid

    Linksline 116

    https://docs.github.com/en/account-and-profile/concepts/username-changes):

  • URL format valid

    Linksline 117

    https://docs.github.com/en/account-and-profile/how-tos):

  • URL format valid

    Linksline 118

    https://docs.github.com/en/account-and-profile/how-tos/account-settings/manage-cookie-preferences):

  • URL format valid

    Linksline 119

    https://docs.github.com/en/account-and-profile/how-tos/contribution-settings/troubleshooting-missing-contributions):

  • URL format valid

    Linksline 120

    https://docs.github.com/en/account-and-profile/how-tos/email-preferences/changing-your-primary-email-address):

  • URL format valid

    Linksline 121

    https://docs.github.com/en/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address):

  • URL format valid

    Linksline 122

    https://docs.github.com/en/account-and-profile/tutorials/personalize-your-profile):

  • URL format valid

    Linksline 128

    https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets):

  • URL format valid

    Linksline 129

    https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories):

  • URL format valid

    Linksline 130

    https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository):

  • URL format valid

    Linksline 131

    https://docs.github.com/en/repositories/creating-and-managing-repositories/quickstart-for-repositories):

  • URL format valid

    Linksline 132

    https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes):

  • URL format valid

    Linksline 133

    https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository):

  • URL format valid

    Linksline 134

    https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases):

  • URL format valid

    Linksline 140

    https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps):

  • URL format valid

    Linksline 141

    https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app):

  • URL format valid

    Linksline 142

    https://docs.github.com/en/apps/maintaining-github-apps):

  • URL format valid

    Linksline 143

    https://docs.github.com/en/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps):

  • URL format valid

    Linksline 144

    https://docs.github.com/en/apps/using-github-apps/authorizing-github-apps):

  • URL format valid

    Linksline 150

    https://docs.github.com/en/actions/get-started/quickstart):

  • URL format valid

    Linksline 151

    https://docs.github.com/en/actions/get-started/understand-github-actions):

  • URL format valid

    Linksline 152

    https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax):

  • URL format valid

    Linksline 158

    https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests):

  • URL format valid

    Linksline 159

    https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests):

  • URL format valid

    Linksline 160

    https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo):

  • URL format valid

    Linksline 164

    https://docs.github.com/en/billing/concepts/product-billing/github-actions):

  • URL format valid

    Linksline 165

    https://docs.github.com/en/billing/concepts/product-billing/github-models):

  • URL format valid

    Linksline 166

    https://docs.github.com/en/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates):

  • URL format valid

    Linksline 167

    https://docs.github.com/en/codespaces):

  • URL format valid

    Linksline 168

    https://docs.github.com/en/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop):

  • URL format valid

    Linksline 169

    https://docs.github.com/en/github-models/use-github-models/prototyping-with-ai-models):

  • URL format valid

    Linksline 170

    https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects):

  • URL format valid

    Linksline 171

    https://docs.github.com/en/migrations/importing-source-code/using-github-importer/about-github-importer):

  • URL format valid

    Linksline 172

    https://docs.github.com/en/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions):

  • URL format valid

    Linksline 173

    https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry):

  • URL format valid

    Linksline 174

    https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api):

  • URL format valid

    Linksline 175

    https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens):

  • URL format valid

    Linksline 176

    https://docs.github.com/en/search-github/github-code-search/understanding-github-code-search-syntax):

  • Company context detected

    AI Discoverability

    The file gives AI systems an identity and high-level description.

  • Documentation links found

    AI Discoverability

    Documentation references help AI assistants ground answers.

  • API links found

    AI Discoverability

    API references help LLM-powered systems understand programmable surfaces.

  • Resource signals found

    AI Discoverability

    The file points AI systems toward supporting resources.

  • Contact information found

    AI Discoverability

    Support or contact information is available for escalation.

  • robots.txt detected

    AI Readiness

    robots.txt is available as an additional readiness signal.