I added an llms.txt to this site when I started thinking about an audience of agents, and writing one by hand is easy to get slightly wrong.
The format is simple, but the details matter if you want tools to read it properly.
The Format
An llms.txt is a markdown file at the root of your site, and it follows a fixed order:
- An H1 with the name of the site or project. It's the only part that's required.
- A blockquote with a one-line summary.
- Any other notes, as plain paragraphs or lists, with no headings.
- H2 sections that each hold a list of links, written as
- [Name](url): notes.
An H2 called Optional is special. Tools can skip the links under it when they need a shorter version, so put the nice-to-haves there.
Here's the start of mine:
# Jon C. Phillips
> Serial builder of side projects and open source software, writing every week about what it takes to build and ship them.
## Main pages
- [Articles](https://joncphillips.com/articles/): Every article, newest first.
Is It Worth Having?
Honestly, it's early. llms.txt is a proposal from llmstxt.org, and none of the big AI companies have said their crawlers use it. Coding agents and docs tools are where it's most useful right now, since an agent can read one file and know where everything is.
It takes about ten minutes to write one, and that seemed like a fair trade to me.
Frequently Asked Questions
Should the links be full URLs?
Yes. The format doesn't strictly require it, but full URLs work wherever the file ends up, including when an agent copies it somewhere else.
What about llms-full.txt?
Some sites also publish an llms-full.txt with the full text of their docs in one file. Put its address in the box and the checker will look at that file instead.
Can I point the links at markdown versions of my pages?
That's actually what the proposal suggests, and it's what I do here. Every page on this site also has a .md version, and agents get far fewer tokens to read that way.