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

Use the portal index for guides and concepts. Use the GraphQL schema files when you need operation lists and query or mutation examples.

Portal 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 schema documentation

• Concise GraphQL index (llms.txt): A list of GraphQL queries and mutations with links to full examples.
  • View online / download: https://developer.appdirect.com/schema/llms.txt
• Complete GraphQL examples (llms-full.txt): Example operations with arguments, variables, and related input and return types.
  • View online / download: https://developer.appdirect.com/schema/llms-full.txt

For recent GraphQL schema updates, see the GraphQL Changelog.

What’s included (structure overview)

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

• APIs and References: GraphQL queries and mutations lists and examples, REST references, and related API landing pages.
• 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
  • For GraphQL operation examples, also reference: https://developer.appdirect.com/schema/llms.txt
  • Ask about REST or GraphQL APIs, Storefront theming, or webhooks; Cursor can ground answers on these docs.

• Windsurf

  • Reference with @https://developer.appdirect.com/llms.txt in prompts.
  • For GraphQL examples, also reference @https://developer.appdirect.com/schema/llms.txt.
  • Optionally add these URLs to your .windsurfrules for persistent access.

• ChatGPT & Claude

  • Mention you’re using the AppDirect Developer Portal and include: https://developer.appdirect.com/llms.txt
  • For GraphQL queries and mutations, also include: https://developer.appdirect.com/schema/llms.txt
  • The model can fetch and ground on these files for more 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?"
• "Using https://developer.appdirect.com/schema/llms.txt, 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."
• "What GraphQL schema changes were recently documented in the changelog?"

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 GraphQL schema files are generated separately from the GraphQL schema. The files follow the LLMs.txt standard for compatibility across tools and are regenerated with each site release to ensure freshness.