Getting Started

Install Nuxt AI Ready

Last updated by Harlan Wilton in doc: sync.

Setup Module

Learn more about what it means to be AI Ready in the introduction.

Install the dependency and add it to your Nuxt config.

bash
npx nuxt module add ai-ready

License

Nuxt AI Search requires a Nuxt SEO Pro license.

NUXT_SEO_PRO_KEY=your-license-key-here

Sign in to see your license key.

MCP Integration (Optional)

Connect AI agents like Claude to your site via Model Context Protocol:

npx nuxi module add @nuxtjs/mcp-toolkit
nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    'nuxt-ai-ready',
    '@nuxtjs/mcp-toolkit',
  ],
})

Then add to Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):

{
  "mcpServers": {
    "my-site": {
      "command": "npx",
      "args": ["-y", "@nuxtjs/mcp-client", "http://localhost:3000/mcp"]
    }
  }
}

See the MCP guide for full details on tools, resources, and dev vs production differences.

Verifying Installation

Nuxt AI Ready works as a zero-config module, so no additional setup is required beyond installation.

Verify features by checking:

  • .md routes: Visit any route on your site and append .md to the URL (e.g., /about.md). You should see the markdown version of that page.

Perform a production build and test the features:

  • /robots.txt shows your Content-Signal.
  • /llms.txt and /llms-full.txt are generated after build with appropriate content.
  • MCP tools return full TOON-formatted content (dev mode only returns route list).

Next Steps

Did this page help you?