Skip to content

llms.txt

These docs are built to be read by machines as comfortably as by people.

The index files

The site serves the llms.txt convention:

  • /llms.txt — a structured index of every page with titles and URLs. Fetch this first to discover the docs' shape.
  • /llms-full.txt — the entire documentation as one markdown document, for agents that prefer a single retrieval.

Per-page markdown

Every page is also available as raw markdown by appending .md to its URL — useful when an agent wants one page without HTML.

Suggested agent workflow

  1. Fetch /llms.txt and locate the relevant section (Photon for relaying, Vector for swaps, Meadow for yield).
  2. Read the product's API reference README for the envelope and auth, then the specific endpoint pages.
  3. For live interaction, prefer the MCP server over raw HTTP — the tools are typed, and submissions are gated behind confirm: true.

The OpenAPI specs under docs/openapi/ in the source repository (photon.yaml, vector.yaml, meadow.yaml) are the machine-readable contracts the reference pages render — agents generating client code should start from those.