Install Nuxt AI Ready

Last updated Oct 13, 2026Harlan Wilton

Setup Module

@nuxtjs/seo v6 includes nuxt-ai-ready. If you use @nuxtjs/seo, skip this step unless you want to manage AI Ready separately.

npx nuxt module add nuxt-ai-ready

npm i nuxt-ai-ready

yarn add nuxt-ai-ready

pnpm i nuxt-ai-ready

bun i nuxt-ai-ready

Use Nuxt 4.6 or Nuxt 5. Use Node 22.22.3+, Node 24.15.0+, or Node 26+.

Import app functions from #ai-ready/app. Import server functions from #ai-ready/server. The module uses built-in SQLite on Node. Bun uses bun:sqlite. Cloudflare uses D1 for stored pages. If you set POSTGRES_URL, Vercel uses Neon. Neon also needs @neondatabase/serverless. See Database Configuration for deployment requirements.

Runtime database setup is skipped when no enabled feature needs stored pages. Prerender indexing uses built-in SQLite on the build machine.

Using an AI agent? Get the nuxt-ai-ready Skill on skilld.dev/gh/harlan-zw/nuxt-ai-ready.

Database Features

The default install has no runtime database. Runtime indexing, cron, MCP site tools, and WebMCP site tools store pages in one. The database needs drizzle-orm, an optional peer dependency. If you turn on one of these features, install it:

npx nypm add drizzle-orm@1.0.0-rc.4

If a feature needs the database and drizzle-orm is missing, the build fails. The build also fails if the installed drizzle-orm is older than 1.0.0-rc.4, such as 0.45. The error names the feature and this install command.

Verifying Installation

Start your development server and request a page as Markdown:

curl http://localhost:3000/about.md

Replace /about with a page that exists in your app. To generate static content files, run nuxi generate or nuxi build --prerender. Then inspect /llms.txt and /llms-full.txt on the preview server or deployed site.

Also check the generated /robots.txt. By default it has a Content Signals line: Content-Signal: search=yes, ai-input=yes.

Configuration

MCP Integration (Optional)

Install MCP Toolkit to expose indexed pages to remote agents. The MCP site tools read stored pages, so also install drizzle-orm:

npx nuxt module add @nuxtjs/mcp-toolkit
npx nypm add drizzle-orm@1.0.0-rc.4

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-ai-ready',
    '@nuxtjs/mcp-toolkit',
  ],
})

Follow the MCP guide to connect a client and configure production access. The MCP endpoint requires a running server.

Rendering Mode Support

Choose how pages enter the index before using search or full-content exports. A normal page visit does not index its content.

Deployment	Markdown pages	Context files	MCP
Static generation	Files for prerendered pages	Generated files	Requires a separate server
Hybrid server	Static files and runtime conversion	Static exports or runtime stored content	Available with Toolkit and indexed pages
SSR server	Runtime conversion	Sitemap links; stored content after indexing	Available with Toolkit and indexed pages
Client-only SPA	No rendered page content to convert	Limited without prerendered content	No page content to index

SSG: nuxi generate indexes prerendered pages and writes static exports. Static hosting cannot run the module's server handlers.

Hybrid: Prerendered pages enter the build index. For an existing page change, call the manual reindex utility. Runtime polling processes pending pages; TTL expiry alone does not reindex healthy stored pages. See runtime indexing for triggers.

SSR-only: Configure runtime sync with a polling trigger, or call the manual indexing utilities. llms.txt can list sitemap URLs before indexing. llms-full.txt streams stored pages once available.

SPA: The converter needs rendered content. Use server rendering or prerender pages that should be readable without client-side JavaScript.