AI coding agents

Give Claude Code, Codex, Cursor, and other agents the Nuxt Photo docs for the installed version through one AGENTS.md pointer, plus llms.txt, Markdown pages, and the docs MCP server.

Agent setup

@lupinum/nuxt-photo ships its documentation inside the package for coding agents such as Claude Code, Codex and Cursor. The pages match the installed version, so an agent does not follow the website for a different version. In a plain Vue app, use @lupinum/vue-photo in place of @lupinum/nuxt-photo below.

To set it up, give your coding agent this task:

Set up @lupinum/nuxt-photo for coding agents as described under "Agent setup" in its README.

Steps for the agent

Find node_modules/@lupinum/nuxt-photo/dist/agent/AGENTS.md. Look in the directory of the project that depends on @lupinum/nuxt-photo first, then in its parent directories up to the repository root (workspaces can hoist packages). Read it; it lists the documentation pages.
Add the section below to the project's agent instructions: AGENTS.md, or CLAUDE.md if the project has only that file. If it has neither, create AGENTS.md. Write the path relative to the repository root, through node_modules/@lupinum/nuxt-photo (for example apps/web/node_modules/@lupinum/nuxt-photo/... in a workspace). Never write a resolved path such as node_modules/.pnpm/...: it contains the version and breaks after an upgrade. If a section for @lupinum/nuxt-photo already exists, leave it as it is.
Use the path you found in place of the sample path:
md
```
## @lupinum/nuxt-photo

Before you change code that uses @lupinum/nuxt-photo, read
`node_modules/@lupinum/nuxt-photo/dist/agent/AGENTS.md` and the pages it
lists. They document the installed version. Prefer them over what you
remember about this package and over the website.
```
Do not copy the documentation into the project and do not install a skill. The section points into the installed package, so it stays correct after every upgrade or downgrade.

If the file does not exist, the installed version has no packaged documentation. Read the package README and its TypeScript types instead.

Read the docs before installing

Every page also has a Markdown version on the site, for an agent that evaluates Nuxt Photo before it is installed. The complete examples on the site become code blocks there.

Source	Use it for
`/llms.txt`	An index of every page with a description.
`/raw/docs/<page>.md`	One page as Markdown.
`/llms-full.txt`	All pages in one file, for a large context.

For example, this page is at https://nuxt-photo.lupinum.com/raw/docs/start/ai-agents.md.

Connect the MCP server

The docs site runs an MCP server with two read-only tools: list-pages and get-page. Add it to an agent that supports remote MCP servers:

.mcp.json

{
  "mcpServers": {
    "nuxt-photo-docs": {
      "type": "http",
      "url": "https://nuxt-photo.lupinum.com/mcp"
    }
  }
}

Let the types answer first

An agent often reads the installed package before any docs. Every public prop and PhotoItem field has a description in the types, with its default and whether it can change after mount. Error messages name the fix and link to the page that explains it. Ask the agent to run your typecheck after a change: most wrong props and missing fields show up there.