How can a coding assistant fetch the Tares docs as plain Markdown, and does an Accept header work?
Tares serves every docs page as plain Markdown when you append .md to the page URL. Start from the index at /tares/llms.txt, and use the all-in-one file /tares/llms-full.txt only when a few pages are not enough. An Accept: text/markdown header does not work, because the server answers with HTML, so use the .md suffix.
How it works
Tares publishes its docs in a form a coding assistant can read without scraping rendered pages. The AI resources page lists the endpoints:
/tares/llms.txtis the Tares index. It lists every page with a one-line description, in reading order. This is the place to start./tares/llms-full.txtholds all Tares pages in one file. It is large, so reach for it only when one or two pages are not enough.- Any page URL plus
.mdreturns that page as Markdown. For example, the Prometheus connector page becomes/tares/connectors/prometheus.md. The docs root is/tares.md. - The site also has a broader
/llms.txtthat covers other products. You do not need it for Tares work.
The Markdown is the same content as the rendered page, without the navigation. That makes it the better input for an assistant than the HTML.
Content negotiation is not supported. If you send an Accept: text/markdown header to a normal page URL, the server still answers with HTML. The .md suffix is the only way to get Markdown for a page.
Set it up
Give your assistant this retrieval order, whether you are Claude Code, Codex, Cursor or an agent of your own.
- Fetch
/tares/llms.txtand read the one-line descriptions. - Pick the one or two pages that match the task and fetch their
.mdURLs. The task router on the AI resources page maps common questions to pages. For example, installation questions go to the quickstart, then the CLI reference. Questions about adding a source go to the connectors index, then the connector’s own page. - Fetch
/tares/llms-full.txtonly if the answer spans many pages. - Do not send an Accept header to ask for Markdown, and do not scrape the HTML pages. Append
.mdinstead. - Treat
llms.txtas a map, not as an answer. The answer is on the pages it points to. - Put the rule in a system prompt or a project instruction file, so the assistant follows it every time:
/tares/llms.txt first, the index
/tares/connectors/prometheus.md then the matching page, as Markdown
/tares.md the docs root- Tell the assistant to cite the page URL it used, and to take connector config keys only from that connector’s page. If a key is not listed there, it should say so and not invent one.
- If the running instance disagrees with the docs, trust the instance and say the docs may be behind. Check the instance with:
tares statusIf you are building an assistant that watches systems and answers incident questions, the AI SRE guide is the page to fetch first after the index.
What you get
- Clean Markdown for any Tares docs page from a single URL change, with no navigation around it.
- A small, ordered entry point in
/tares/llms.txt, so the assistant reads two pages and not the whole site. - One big file,
/tares/llms-full.txt, for the cases that span many pages. - Answers that stay close to the docs: commands, flags and connector keys come from the pages, and the assistant cites the URL it used.
- No surprises about headers. You know that
Accept: text/markdownreturns HTML, so you do not build logic around it.
When something else fits
- If the answer spans many pages,
/tares/llms-full.txtsaves you from fetching them one by one, at the cost of a large file. - If you need the live state of a running Tares and not the docs, ask the instance directly with
tares status. The docs can be behind a running instance.
Related
Still stuck? Get help