Using these docs with an AI agent
How a coding agent or chatbot reads FloorPlanCraft's docs as Markdown: llms.txt, llms-full.txt, .md addresses and Accept: text/markdown.
Updated · View as Markdown
Every page of these docs is also plain Markdown, made from the same source as the web page. An AI agent can read it without a browser, and you can give its address to any agent that fetches web pages.
Where the Markdown is
| Address | What it holds |
|---|---|
https://floorplancraft.com/llms.txt | The index: every docs page by section, with a one-line description and its Markdown address |
https://floorplancraft.com/llms-full.txt | Every docs page in one file |
https://floorplancraft.com/docs.md | The same index as llms.txt |
https://floorplancraft.com/docs/<page>.md | One page. Add .md to any docs address, such as https://floorplancraft.com/docs/developer-overview.md. |
Open llms.txt or llms-full.txt to see what an agent gets.
An agent can also ask for a docs address with the header Accept: text/markdown and get the Markdown instead of the web page:
curl -H "Accept: text/markdown" https://floorplancraft.com/docs/connect-an-app
curl https://floorplancraft.com/docs/connect-an-app.mdLinks inside the Markdown go to other pages' Markdown addresses, so an agent can follow them. Each page ends with the address of its web page and the date it was last checked.
What to ask an agent
- Answer a question. "Read https://floorplancraft.com/llms.txt, open the pages you need and answer from them, naming each page you used."
- Connect your own system to Live 3D. Paste one of the prompts for coding agents: for a play venue POS, a restaurant POS or a booking app.
- Check an integration. "Compare our FloorPlanCraft integration with https://floorplancraft.com/docs/live-updates.md and list every field or rule we handle differently."
- Find the cause of an error. "Our pushes get
401 invalid_signature. Read https://floorplancraft.com/docs/signing-requests.md and check our signing code against its test vectors."
Good practice
- Give the agent the Markdown address rather than the web page: it is shorter and has no menus.
- For one task, give it the pages it needs.
llms-full.txtholds everything, so use it when the agent needs the whole picture. - Ask the agent to name the page behind each answer, so you can check it.
- Keep secrets out of the chat. An agent that writes integration code never needs your real
connectionSecret: it belongs in your server's settings. - These docs give an agent no access to your account. Connecting an app always needs the venue owner to sign in and press Approve and connect in a browser.