LLMs-ready documentation

What is LLMs.txt?

AppDirect provides LLM-friendly documentation so AI tools (Cursor, Windsurf, GitHub Copilot, ChatGPT, Claude, and others) can understand and work with the AppDirect Developer Portal content.

The LLM files are automatically generated from our docs at build time and are refreshed with each release.

Available documentation

• Concise index (llms.txt): Optimized for fast ingestion by AI tools.
  • View online / download: https://developer.appdirect.com/llms.txt
• Complete documentation (llms-full.txt): Full content following the LLMs.txt standard.
  • View online / download: https://developer.appdirect.com/llms-full.txt

GraphQL

• Concise GraphQL index (llms.txt)
  • View online / download: https://developer.appdirect.com/schema/llms.txt
• Complete GraphQL examples (llms-full.txt)
  • View online / download: https://developer.appdirect.com/schema/llms-full.txt

What each file includes:

• In llms.txt: A complete list of all GraphQL queries and mutations with brief descriptions and links.
• In llms-full.txt: A full example for every query and mutation, plus all input/output types (including nested types), arguments, enums, and return details.

What’s included (structure overview)

Based on our current llms.txt, the documentation covers:

• APIs and References: GraphQL Queries and Mutations List & Exmaples.
• User Guides: API usage (authentication, GraphQL, REST), products, billing/subscriptions, inventory, extensions, notifications, reseller, search, checkout, and more.
• Storefront: Getting started, how-to guides (components, data, localization, static assets, checkout, headers/footers, meta tags, pages, uploads), reference (page objects, templating language, theme structure, toolkit commands), installation, and developer tools.
• Webhooks: Concepts, configuration, authentication, payloads, resources, troubleshooting, and examples.
• Developer tools: GraphQL Explorer, schema introspection, demo explorer.
• Internal/AI: AppDirect AI API reference and AI user guides (best practices, prompt engineering, data sources, getting started).

This index helps LLMs navigate the site and link to specific pages.

Use with AI tools

• Cursor

  • Type @Docs in your prompt and reference: https://developer.appdirect.com/llms.txt
  • Ask about REST/GraphQL endpoints, Storefront theming, or webhooks; Cursor will ground answers on our docs.

• Windsurf

  • Reference with @https://developer.appdirect.com/llms.txt in prompts.
  • Optionally add the URL to your .windsurfrules for persistent access.

• ChatGPT & Claude

  • Mention you’re using the AppDirect Developer Portal and include: https://developer.appdirect.com/llms.txt
  • The model will fetch and ground on our documentation for accurate answers.

• GitHub Copilot

  • Copilot cannot fetch external docs directly. Paste small, relevant snippets or link to specific pages so suggestions are better aligned.

Example prompts

• "Where are AppDirect REST API rate limits documented, and what are the defaults?"
• "Show a GraphQL mutation to create product editions and explain required fields."
• "Steps to upload a Storefront theme"
• "How do I configure webhook authentication and validate payload signatures?"
• "Send custom metered usage v2 events with examples and limits."

How it’s generated

Our LLM files are built using an automated process that compiles pages, reference content, and navigation into machine-friendly text. The files follow the LLMs.txt standard for compatibility across tools. They are regenerated with each site release to ensure freshness.