Skip to content

Using this documentation with an AI agent

Every page of this site is published twice: as the HTML you are reading, and as the raw markdown it was written from. An agent reads the markdown — no scraping, no HTML stripping.

Three ways in

You want Fetch
one page that page's .md URL
the list of every page /llms.txt
the whole site in one file /llms-full.txt

This follows the llms.txt convention.

One page

Take the page's URL, drop the trailing slash, add .md:

https://docs.muppy.io/muppy_manganese/services-yml-guide/     ← the page
https://docs.muppy.io/muppy_manganese/services-yml-guide.md   ← its markdown
curl -s https://docs.muppy.io/muppy_manganese/services-yml-guide.md

Pages that open a section

A page that opens a section — /app_servers/, /muppy_k8s/, /guides/postgresql/ — is written as an index.md inside its own directory, and its markdown stays there. The rule above would send you one level too high:

https://docs.muppy.io/app_servers/            ← the page
https://docs.muppy.io/app_servers/index.md    ← its markdown
https://docs.muppy.io/app_servers.md          ← 404, this file does not exist

25 of the 142 pages are of that kind. If a .md URL returns 404, append index.md to the page URL instead of replacing the trailing slash.

Better still, don't derive URLs at all: every link in llms.txt is exact, section pages included.

Your browser may download the .md instead of displaying it. That is the browser, not the site — curl shows it, and an agent reads it either way.

The index — llms.txt

A 15 KB markdown index: the site's name, one line on what Muppy is, then a link to the markdown of all 141 pages. Give an agent this URL and it can pick what it needs.

curl -s https://docs.muppy.io/llms.txt

Everything — llms-full.txt

Every page concatenated, each behind a banner naming its title and source path. About 580 KB — roughly 145,000 tokens.

That fits a large-context model in one shot. It does not fit a small one: use llms.txt there and fetch the handful of pages that matter.

What to say to an agent

Paste a URL and the question:

Read https://docs.muppy.io/llms.txt, then tell me how to schedule a PostgreSQL backup in Muppy.

Read https://docs.muppy.io/llms-full.txt. My App Server's build fails in mpy_setup.sh — what stage runs when, and what environment variables can I read?

Agents that browse the web fetch these directly. For one without web access, curl the file and paste it in.

Claude Code on an App Server

An App Server's browser IDE ships with Claude Code, which fetches URLs itself. Point it at llms.txt and let it pull the pages it needs — cheaper than pasting the whole site into the conversation.