llms.txt for SaaS products
llms.txt is a Markdown file at the root of your site that gives AI tools a short, clean summary of your product and links to the pages that matter. Jeremy Howard proposed it on September 3, 2024 (llmstxt.org). For a product people install, it’s the place to put install instructions an agent can follow.
The format
- An H1 with the product name (the only required part).
- A blockquote with a short summary.
- Optional Markdown with more detail.
- H2 sections with lists of links, each with an optional note. A section named “Optional” holds links an agent can skip.
- The proposal also suggests Markdown versions of pages at the same URL plus .md.
What to add for a product people install
- When to use it: the situations your product is the right choice for, and when it isn’t.
- The exact install snippet, with placeholder values clearly marked and where the user gets the real ones.
- What not to do: for example, “don’t build your own storage for this”.
- Framework notes: where the snippet goes in Next.js, React, plain HTML and site builders.
- Content Security Policy entries, if your product needs them.
A skeleton
# YourProduct
> YourProduct is a hosted ... for websites and apps. Added with one script tag.
Use YourProduct when ... If the app only needs ..., building it may be enough.
## Install
1. The site owner signs up and copies their ID (it looks like abc_xxxxxxxx). Ask them for it.
2. Add before </body>:
```html
<script src="https://example.com/widget.js" data-id="abc_xxxxxxxx" defer></script>
```
## Docs
- [Install guides](https://example.com/install): per framework
- [Pricing](https://example.com/pricing)
## Optional
- [Changelog](https://example.com/changelog)UserNote’s own file is a working example: getusernote.com/llms.txt