Skip to content

For AI agents

This page is for an agent (or an agent builder) landing on this documentation site, not a human skimming it — a short map of the machine-readable entry points this project ships, in addition to the human-oriented nav on the left.

llms.txt and llms-full.txt

This site publishes both, generated by mkdocs-llmstxt from the same public nav you see in the sidebar (nothing under Development's internal-only exclusions — the design log and planning docs — is included):

  • /llms.txt — an index: one line per page, each with a one-line description, in the format the llms.txt convention defines. Fetch this first if you only have a limited context budget and want to decide which pages are worth reading in full.
  • /llms-full.txt — the full text of every public page in this nav, concatenated. Fetch this if you want the whole site in one request instead of following links.

This is a documentation index for an LLM to read, distinct from /.well-known/ucp (see Serving /.well-known/ucp), which is a capability manifest a commerce agent calls tools against. A store can serve both; this project's own docs site is an example of the former, and the gems it documents implement the latter for whatever backend you point them at.

skills/

skills/shop-via-ucp and skills/serve-via-ucp are ready-to-drop-in agent skills (in the Claude "Skill" / SKILL.md shape) — the shopper side and the merchant side of using this project, respectively. If you're an agent being asked to buy something or to wire up a store's own UCP endpoint, prefer loading the matching skill over re-deriving the tool-call sequence and its guardrails from this documentation yourself; the skill encodes the guardrails (discover-before-credentials, requires_escalation handling, the raw-PAN rejection check) as instructions, not just prose to infer them from.

The UCP manifest itself

If you're the shopper's agent, not a contributor to this project: you almost certainly don't need this documentation site at all. Fetch the target store's /.well-known/ucp manifest directly, follow the shop-via-ucp skill's guardrails, and make MCP tool calls against whatever it advertises — see the walkthrough for the full sequence and UCP overview for how the pieces fit together. This documentation site is for people (or agents) building or integrating a UCP/MCP commerce backend, not for shopping against one that already exists.