mage2kishan/module-llms-txt
Composer 安装命令:
composer require mage2kishan/module-llms-txt
包简介
Panth LLMs.txt — AI Indexing Engine for Magento 2. Serves structured /llms.txt, /llms-full.txt and /llms.json with a dynamic multi-URL sitemap engine, weighted ranking, auto-generated summaries, product-type and use-case grouping, and cron-based cache warm-up. Built for ChatGPT, Claude, Perplexity,
README 文档
README
Magento 2 LLMs.txt Extension: AI-Readable Store Index for ChatGPT, Claude, Perplexity, Gemini (Hyva + Luma)
Let every AI assistant read your store the way you want it described. Panth LLMs.txt generates and serves
/llms.txt,/llms-full.txt, and/llms.jsonstraight from your Magento catalog. No cron, no extra files to maintain. Cache auto-invalidates on every admin save.
Product page: kishansavaliya.com/magento-2-llms-txt.html
Quick Answer
What is Panth LLMs.txt? It is a Magento 2 extension that publishes a structured Markdown index of your store at /llms.txt, following the llmstxt.org standard. AI assistants like ChatGPT, Claude, Perplexity, and Gemini read this file to understand your catalog, categories, policies, and products.
What does it add to my store?
- A
/llms.txtendpoint with a hierarchical category tree, store overview, priority URLs, collections, CMS key pages, and three curated product sections (Featured, Best Sellers, Recent Arrivals). - A
/llms-full.txtendpoint that appends the full text of your Shipping, Returns, FAQ, and About Us pages so AI assistants can quote your policies verbatim. - A
/llms.jsonendpoint with the same data in a stable JSON schema for programmatic consumers. - A sitemap engine that reads your XML sitemaps, scores every URL by type and priority, and surfaces the highest-scored pages.
- Use-case buckets so you can group category IDs under shopper intents like "Daily Wear" or "Bridal".
Which themes are supported? Both Hyva and Luma. The file is served from a backend controller with no theme dependency.
What does it need? Magento 2.4.4 to 2.4.8, PHP 8.1 to 8.4, and the free mage2kishan/module-core package.
Need Custom Magento 2 Development?
Get a free quote for your project in 24 hours for custom modules, Hyva themes, performance work, M1 to M2 migrations, and Adobe Commerce Cloud.
Visit our website: kishansavaliya.com | Get a quote: kishansavaliya.com/get-quote
Table of Contents
- Who Is It For
- Key Features
- Screenshots
- Example Output
- Compatibility
- Installation
- Configuration
- How It Works
- FAQ
- Support
- About Panth Infotech
- Quick Links
Who Is It For
- Merchants who want AI referral traffic from ChatGPT, Perplexity, Gemini, and Claude when shoppers ask about products in your niche.
- Stores with policy-heavy customer service (shipping, returns, FAQ) that want AI assistants to quote the correct wording instead of guessing.
- Multi-store merchants who need per-store index files with the right URLs, currency, and locale for each brand.
- Hyva and Luma stores that want a standards-compliant
/llms.txtwithout writing or maintaining it by hand. - SEO-focused teams who are preparing their store for the shift toward AI-powered search and zero-click answers.
Key Features
Three Output Formats
/llms.txt- compact, token-efficient Markdown (5 to 10 KB): store overview block, company info, priority URLs, collections, CMS key pages, hierarchical category tree, and three curated product sections./llms-full.txt- same as above plus the full text of your Shipping, Returns, FAQ, and About Us pages inline, so AI assistants quote your policies exactly./llms.json- the same data in a stable machine-readable JSON schema (panth.llms_txt/v1) for programmatic consumers.
Curated Product Sections
- Featured Products - merchant-flagged via a configurable yes/no EAV attribute (default
is_featured). Section is silently skipped if the attribute does not exist. - Best Sellers - read from Magento's
sales_bestsellers_aggregated_yearlytable, no extra queries at render time. - Recent Arrivals - sorted by
created_at DESC. - Each product line includes name, URL, price, SKU, category, and an optional one-line short description. The description resolver falls back through
short_description,meta_description, first sentence ofdescription, and an auto-generatedName + Categoryfallback.
Hierarchical Category Tree
- Nested Markdown list so AI assistants see the real parent-child relationships, not a flat list of duplicate names.
- Configurable depth (1 to 5 levels).
Sitemap Engine
- Reads one or more XML sitemaps (plain
<urlset>or<sitemapindex>with one nesting level). - Absolute or relative sitemap URLs, with comment lines (
#) supported. - Auto-detects
{baseUrl}sitemap.xmlwhen the list is empty. - Scores every parsed URL by type (homepage, category, product, CMS, etc.) and priority.
- Renders the top-scored rows under a
## Sitemap Highlightssection with a configurable cap. - Separate TTL and per-request timeout settings.
Weighting and Ranking
- Combines sitemap priority, admin-pinned URLs, and built-in type weights into a single 0.0 to 1.0 score per entry.
- Type weights are editable per store view (
category=0.75,product=0.55, etc.). - Pinned URLs override every other signal, including wildcard path trees (
/sale/*=1.0). - Minimum score threshold drops low-value URLs automatically.
Use-Case Buckets (Shopper Intent)
- Admin defines shopper intent groups with a label, one or more category IDs, and an optional summary line.
- Rendered under
## Use Casesso AI assistants can match a shopper question ("looking for bridal wear") to the right category set.
Product Types Section
- Optional metadata block listing counts per Magento product type (simple, configurable, bundle, etc.).
- Lets AI assistants understand whether your store carries configurable products or mainly simple SKUs.
Optional Integrations
- Panth Testimonials - adds approved testimonial pages if
Panth_Testimonialsis installed. - Panth FAQ - adds FAQ categories and items if
Panth_Faqis installed. - Panth Dynamic Forms - adds page-type dynamic forms if
Panth_DynamicFormsis installed. - Each integration is conditional: if the source module is absent, the section renders nothing silently.
Built-In Caching
- Dedicated cache type
panth_llms_txtvisible in System > Cache Management. - Tag-invalidated on any admin save of a category, product, CMS page, or store config.
- Optional nightly cron at 02:30 (
Cache Warm-upgroup) pre-warms all enabled stores. - Cold render: around 200 ms on a 2,000-SKU catalog. Warm: around 50 ms.
Multi-Store and Multi-Language
- Full store emulation wraps every render: URLs, prices, and locales resolve in the target store's context.
- Per-store summary, limits, priority URLs, collections, exclusions, and product caps.
- Per-store cache entries invalidate independently.
SEO-Friendly HTTP Headers
Content-Type: text/plain; charset=utf-8X-Robots-Tag: noindex- keeps the raw file out of Google search results.Content-Disposition: inline; filename="llms.txt"Cache-Control: public, max-age=3600- CDN-friendly.
Zero Maintenance
- No database tables, no cron required (optional warm-up cron available), no external API calls.
- Cache auto-invalidates on merchant edits.
- URL rewrites installed once via a data patch (idempotent on re-run).
Screenshots
Admin Configuration - Stores > Configuration > Panth Extensions > LLMs.txt
Admin config groups: General, Sitemap Engine, Weighting and Ranking, Content Limits, Curated Products, Product Types, Use Cases, llms-full.txt, llms.json, Cache Warm-up, Optional Integrations. Every setting is store-view scoped.
/llms-full.txt - Default Store View (Hyva)
/llms-full.txt - Luma Store View
Same renderer, different store view. Store emulation ensures every URL resolves in the correct store context.
Example Output
A typical /llms.txt from a Magento sample-data catalog:
# Your Store Name > Short one-line store summary goes here. ## Store Overview - URL: https://yourstore.com/ - Type: E-commerce catalog (Magento 2) - Store View: Default Store View - Currency: USD - Language: en_US - Generated: 2026-04-23 12:00:00 UTC ## Company - Email: hello@yourstore.com - Phone: +1-555-0000 ## Priority URLs - [Sale](https://yourstore.com/sale.html) - [New Arrivals](https://yourstore.com/what-is-new.html) ## Collections - [Eco Friendly](https://yourstore.com/collections/eco-friendly.html) ## Key Pages - [About us](https://yourstore.com/about-us): Our story and mission - [Shipping Policy](https://yourstore.com/shipping-policy) - [Returns & Refunds](https://yourstore.com/returns) ## Category Tree - [Women's Fashion & Clothing](https://yourstore.com/women.html) - [Tops](https://yourstore.com/women/tops-women.html) - [Jackets](https://yourstore.com/women/tops-women/jackets-women.html) - [Bottoms](https://yourstore.com/women/bottoms-women.html) - [Men](https://yourstore.com/men.html) - [Tops](https://yourstore.com/men/tops-men.html) ## Featured Products - [Push It Messenger Bag](https://yourstore.com/push-it-messenger-bag.html) - $45.00 - SKU 24-WB04 - Bags Slim, durable messenger bag for daily commutes. ## Best Sellers - [Ina Compression Short](https://yourstore.com/ina-compression-short.html) - $49.00 - SKU WSH11 - Shorts Compression running short with exceptional support. ## Recent Arrivals - [Sample Product](https://yourstore.com/sample.html) - $99.99 - SKU sample-001 - Bags New arrival sample product. ## Sitemaps - https://yourstore.com/sitemap.xml - https://yourstore.com/robots.txt - https://yourstore.com/llms-full.txt
/llms-full.txt adds full policy bodies inline. /llms.json provides the same data as structured JSON.
Compatibility
| Requirement | Versions Supported |
|---|---|
| Magento Open Source | 2.4.4, 2.4.5, 2.4.6, 2.4.7, 2.4.8 |
| Adobe Commerce | 2.4.4, 2.4.5, 2.4.6, 2.4.7, 2.4.8 |
| Adobe Commerce Cloud | 2.4.4 to 2.4.8 |
| PHP | 8.1.x, 8.2.x, 8.3.x, 8.4.x |
| MySQL | 8.0+ |
| MariaDB | 10.4+ |
| Hyva Theme | 1.0+ (native support) |
| Luma Theme | Native support |
| Required Dependency | mage2kishan/module-core (free) |
Installation
Composer Installation (Recommended)
composer require mage2kishan/module-llms-txt bin/magento module:enable Panth_Core Panth_LlmsTxt bin/magento setup:upgrade bin/magento setup:di:compile bin/magento setup:static-content:deploy -f bin/magento cache:flush
Manual Installation via ZIP
- Download the latest release from Packagist or from the product page.
- Extract it to
app/code/Panth/LlmsTxt/in your Magento install. - Make sure
Panth_Coreis installed too (required dependency). - Run the commands above starting from
bin/magento module:enable.
Verify Installation
bin/magento module:status Panth_LlmsTxt # Expected: Module is enabled curl https://yourstore.com/llms.txt | head -20 # Expected: Markdown body starting with "# Your Store Name"
Configuration
Navigate to Admin > Stores > Configuration > Panth Extensions > LLMs.txt. Settings are grouped into these fieldsets:
General (group: llms_txt)
| Setting | Default | Description |
|---|---|---|
| Enable llms.txt | Yes | Master toggle. When off, /llms.txt returns 404. |
| Site Summary | (auto) | One-line summary under the H1. Auto-generates from store metadata when blank. Falls back to design/head/default_description. |
| Priority URLs | (empty) | One URL per line, format `Label |
| Collections (Category IDs) | (empty) | Comma-separated category IDs for curated landing pages. Rendered under ## Collections. |
Sitemap Engine (group: sitemap)
| Setting | Default | Description |
|---|---|---|
| Sitemap URLs | (empty) | One sitemap URL per line. Absolute or relative. Lines starting with # are comments. Empty list uses /sitemap.xml. |
| Auto-detect Default Sitemap | Yes | Fall back to {baseUrl}sitemap.xml when the URL list is empty. |
| Render "Sitemap Highlights" Section | Yes | List the highest-scored sitemap rows under their own section. |
| Max Rendered Sitemap Rows | 50 | Hard cap on rows under ## Sitemap Highlights. |
| Max Parsed Sitemap Entries | 5000 | Upper bound on entries loaded across all sitemaps. |
| Per-request Timeout (seconds) | 8 | Per-sitemap connect and read timeout. |
| Sitemap Cache TTL (seconds) | 3600 | How long parsed sitemap data stays cached. |
Weighting and Ranking (group: weighting)
| Setting | Default | Description |
|---|---|---|
| Type Weights | (built-in defaults) | code=weight per line. Codes: homepage, category, collection, product, cms, sitemap, external. |
| Pinned URLs | (empty) | url_or_prefix=score per line. Wildcard: /sale/*=1.0 pins the entire path tree. |
| Minimum Score | 0.20 | Entries below this are dropped. |
| Max Entries Per Section | 200 | Per-section hard cap applied after sorting. |
Content Limits (group: limits)
| Setting | Default | Description |
|---|---|---|
| Max Category Tree Depth | 3 | How many levels of the taxonomy to render (1 to 5). |
| Max CMS Pages | 10 | Cap on ## Key Pages. |
| Exclude CMS Identifiers | (empty) | Extra identifiers to skip (appended to built-in exclusions). |
Curated Products (group: products)
| Setting | Default | Description |
|---|---|---|
| Featured Attribute Code | is_featured |
Yes/No EAV attribute used to flag featured products. Section silently skipped if the attribute does not exist. |
| Max Featured Products | 6 | Cap on ## Featured Products. Set 0 to disable. |
| Show Best Sellers | Yes | Render ## Best Sellers from Magento's bestseller aggregate. |
| Max Best Sellers | 10 | Cap on ## Best Sellers. |
| Show Recent Arrivals | Yes | Render ## Recent Arrivals sorted by created_at DESC. |
| Max Recent Arrivals | 10 | Cap on ## Recent Arrivals. |
| Include Short Descriptions | Yes | One-line description under each product. Resolver: short_description then meta_description then first sentence of description then auto-generated fallback. |
Product Types Section (group: product_types)
| Setting | Default | Description |
|---|---|---|
| Render "Product Types" | No | Include a metadata block with counts per Magento product type. |
Use Cases (group: use_cases)
| Setting | Default | Description |
|---|---|---|
| Use-case Buckets | (empty) | `Label |
llms-full.txt (group: full)
| Setting | Default | Description |
|---|---|---|
| Enable llms-full.txt | No | Master toggle for the expanded variant. |
| Shipping Policy CMS Identifier | (empty) | Example: shipping-policy. Full page body embedded in /llms-full.txt. |
| Returns Policy CMS Identifier | (empty) | Example: returns-policy. |
| About Us CMS Identifier | (empty) | Example: about-us. |
| FAQ CMS Identifier | (empty) | Example: faq. |
llms.json (group: json)
| Setting | Default | Description |
|---|---|---|
| Enable /llms.json | No | Serves the same data as a structured JSON document at /llms.json (schema: panth.llms_txt/v1). |
Cache Warm-up (group: cron)
| Setting | Default | Description |
|---|---|---|
| Pre-warm Caches via Cron | No | When on, a nightly cron at 02:30 regenerates /llms.txt, /llms-full.txt, and /llms.json for every enabled store. |
Optional Integrations (group: optional)
| Setting | Default | Description |
|---|---|---|
| Include Testimonials | No | Adds testimonial pages from Panth_Testimonials if that module is installed. |
| Include FAQs | No | Adds FAQ items from Panth_Faq if that module is installed. |
| Include Dynamic Forms | No | Adds page-type forms from Panth_DynamicForms if that module is installed. |
How It Works
The module is pull-based. There is no cron that writes files to disk (the optional warm-up cron is for pre-heating the cache only).
- A crawler hits
https://yourstore.com/llms.txt. - The
Index.phpcontroller receives the request. - The Builder checks the
panth_llms_txtcache.- Cache hit: returns the cached Markdown body immediately (around 50 ms).
- Cache miss: composes fresh output from Magento's store, catalog, CMS, and sitemap APIs, caches it, then returns (around 200 ms).
- The controller adds the correct HTTP headers and streams the response.
The same pattern applies to Full.php (for /llms-full.txt) and Json.php (for /llms.json).
When does the output refresh?
| Event | Result |
|---|---|
| Admin saves any category | Cache invalidated via Category::CACHE_TAG |
| Admin saves any product | Cache invalidated via Product::CACHE_TAG |
| Admin saves any CMS page | Cache invalidated via Page::CACHE_TAG |
| Admin saves store configuration | Cache invalidated via config_scopes |
| Admin clicks Flush Magento Cache | Full flush |
bin/magento cache:clean panth_llms_txt |
This module's cache only |
| 1-hour TTL lapse | Passive regeneration on the next request |
Practical refresh time: within seconds of any admin edit. The next request after a save regenerates. Worst case on an idle store: stale by at most 1 hour.
Nginx note for HEAD requests
Some LLM crawlers and SEO auditors probe with HEAD before GET. The direct routes (/panth_llms/llms/index, /panth_llms/llms/full, /panth_llms/llms/json) answer HEAD with 200. For the friendly /llms.txt path through Magento's URL rewrite layer, add the bundled nginx snippet:
include /path/to/vendor/mage2kishan/module-llms-txt/etc/nginx.conf.sample;
Place it inside your server { ... } block before the catch-all location / block, then reload nginx.
FAQ
Is llms.txt an official standard?
It is an emerging community standard proposed at llmstxt.org. Anthropic, Perplexity, Vercel, Stripe, and Cloudflare all publish one. Not an IETF RFC yet, but widely adopted by major AI platforms.
Does this replace my XML sitemap?
No. Keep your XML sitemap for Google and Bing. /llms.txt is for AI crawlers that want a curated summary rather than a full crawlable list.
Will Google index my /llms.txt as a search result?
No. The controller sends X-Robots-Tag: noindex. Crawlers still read the file for signals.
Does it run a cron job?
The module is pull-based by default. There is an optional nightly warm-up cron at 02:30 you can enable under the Cache Warm-up group. The base functionality works with no cron at all.
Does it work with Hyva?
Yes. The file is served at the backend layer, outside the theme pipeline. Identical behavior on Hyva and Luma.
Is Panth_Core required?
Yes. mage2kishan/module-core is a required dependency pulled in automatically by Composer.
Will this slow down my store?
No. Output is cached with a 1-hour TTL plus tag invalidation. LLM crawlers hit this infrequently compared to FPC. Your storefront pages are not affected.
How do I flag products as featured?
Create a yes/no EAV attribute called is_featured from Stores > Attributes > Product, or enter a different attribute code in the admin config. Flip the flag on the products you want shown.
What does the sitemap engine add beyond the category tree?
It reads your actual sitemap XML files, scores every URL by type and admin-defined weights, and surfaces the highest-ranked pages in a dedicated ## Sitemap Highlights section. This gives AI assistants a priority-ordered view of your catalog beyond just the category structure.
What are use-case buckets?
They let you group categories under shopper intents. For example Bridal | 41 | Hand-embroidered bridal wear maps a natural-language intent to the right category IDs. AI assistants can then answer "where do I find bridal wear at your store?" with an accurate link.
Can I add custom sections?
Yes. The architecture is section-based. Each ## Heading block is a class implementing SectionInterface. Add a custom section in a child module and wire it via di.xml without touching existing code.
Does it support multi-language stores?
Yes. Each store view gets its own cache entry, URLs, summary, and all store-scope config values. Store emulation ensures prices and locale are correct per store.
What about GDPR and privacy?
Only data already public on your store is published: product names, category names, CMS page titles, and company info from Store Information. No customer data, no order details.
Support
| Channel | Contact |
|---|---|
| Product Page | kishansavaliya.com/magento-2-llms-txt.html |
| kishansavaliyakb@gmail.com | |
| Website | kishansavaliya.com |
| +91 84012 70422 | |
| GitHub Issues | github.com/mage2sk/module-llms-txt/issues |
| Upwork (Top Rated Plus) | Hire Kishan Savaliya |
| Upwork Agency | Panth Infotech |
Response time: 1-2 business days.
Need Custom Magento Development?
Looking for custom Magento module development, Hyva theme work, store migrations, or performance tuning? Get a free quote in 24 hours:
About Panth Infotech
Built and maintained by Kishan Savaliya (kishansavaliya.com), a Top Rated Plus Magento developer on Upwork with 10+ years of eCommerce experience.
Panth Infotech is a Magento 2 development agency that builds high quality, security focused extensions and themes for both Hyva and Luma storefronts. The extension suite covers AI SEO, classical SEO, performance, checkout, product presentation, customer engagement, and store management, with each module built to MEQP standards and tested across Magento 2.4.4 to 2.4.8.
Browse the full extension catalog on our Magento extensions page or on Packagist.
Quick Links
| Resource | Link |
|---|---|
| Product Page | magento-2-llms-txt.html |
| Packagist | mage2kishan/module-llms-txt |
| GitHub | mage2sk/module-llms-txt |
| Website | kishansavaliya.com |
| Free Quote | kishansavaliya.com/get-quote |
| Upwork (Top Rated Plus) | Hire Kishan Savaliya |
| Upwork Agency | Panth Infotech |
| kishansavaliyakb@gmail.com | |
| +91 84012 70422 |
Ready to make your store readable by every AI assistant?
SEO Keywords: magento 2 llms.txt, magento 2 ai seo, magento 2 chatgpt indexing, magento 2 claude seo, magento 2 perplexity seo, magento 2 gemini seo, magento 2 ai crawler, magento 2 llms-full.txt, magento 2 llms json, magento 2 ai site map, llmstxt.org magento, magento 2 hierarchical category tree ai, magento 2 featured products llm, magento 2 bestsellers ai, magento 2 recent products ai seo, magento 2 ai content optimization, hyva llms.txt, hyva ai seo, luma llms.txt, luma ai seo, magento 2 markdown sitemap, magento 2 content for llm, magento 2 generative ai seo, magento 2 openai search, magento 2 bing copilot, magento 2 microsoft copilot seo, magento 2 ai shopping, magento 2 conversational commerce, magento 2 ai assistant seo, magento 2 ai policy page, magento 2 shipping policy ai, magento 2 returns policy ai, magento 2 sitemap engine, magento 2 url scoring, magento 2 use case buckets, magento 2 shopper intent seo, magento 2.4.8 llms.txt, magento 2 php 8.4 llms.txt, mage2kishan llms.txt, panth infotech llms.txt, kishan savaliya magento, hire magento developer upwork, top rated plus magento freelancer, custom magento development, adobe commerce llms.txt, magento 2 ai-powered seo
统计信息
- 总下载量: 36
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 2
- 点击次数: 31
- 依赖项目数: 0
- 推荐数: 1
其他信息
- 授权协议: proprietary
- 更新时间: 2026-04-22



