Nuxt API

Configuration

Last updated by Harlan Wilton in fix!: rework module.
nuxt.config.ts
export default defineNuxtConfig({
  aiReady: {
    // options
  }
})

enabled

  • Type: boolean
  • Default: true
aiReady: {
  enabled: process.env.NODE_ENV === 'production'
}

debug

  • Type: boolean
  • Default: false

Enable debug logging for module operations.

mdreamOptions

  • Type: HTMLToMarkdownOptions & { preset?: 'minimal' }
  • Default: { preset: 'minimal' }

Configure mdream HTML-to-markdown conversion.

export default defineNuxtConfig({
  aiReady: {
    mdreamOptions: {
      preset: 'minimal'
    }
  }
})

markdownCacheHeaders

  • Type: { maxAge?: number, swr?: boolean }
  • Default: { maxAge: 3600, swr: true }

Cache settings for runtime markdown endpoints.

OptionTypeDefaultDescription
maxAgenumber3600Cache duration in seconds
swrbooleantrueStale-while-revalidate

llmsTxt

  • Type: LlmsTxtConfig
  • Default: Auto-generated

Configure llms.txt generation.

export default defineNuxtConfig({
  aiReady: {
    llmsTxt: {
      sections: [
        {
          title: 'API Reference',
          links: [
            { title: 'REST API', href: '/docs/api', description: 'API docs' }
          ]
        }
      ],
      notes: 'Built with Nuxt AI Ready'
    }
  }
})

LlmsTxtSection:

PropertyTypeDescription
titlestringSection title
descriptionstring | string[]Section description
links{ title, href, description? }[]Links in section

LlmsTxtConfig:

PropertyTypeDescription
sectionsLlmsTxtSection[]Custom sections
notesstring | string[]Notes at end

contentSignal

  • Type: false | { aiTrain?: boolean, search?: boolean, aiInput?: boolean }
  • Default: false

Content Signal directives for robots.txt. See Content Signals guide.

export default defineNuxtConfig({
  aiReady: {
    contentSignal: {
      aiTrain: false, // Block training
      search: true, // Allow search indexing
      aiInput: true, // Allow RAG/grounding
    }
  }
})

mcp

  • Type: { tools?: boolean, resources?: boolean }
  • Default: { tools: true, resources: true }

Control MCP features when @nuxtjs/mcp-toolkit installed.

export default defineNuxtConfig({
  aiReady: {
    mcp: {
      tools: true, // list_pages, search_pages_fuzzy
      resources: true, // pages resource
    }
  }
})

See MCP guide for tool/resource details.

cacheMaxAgeSeconds

  • Type: number
  • Default: 600 (10 minutes)

Cache duration for llms.txt route handlers. Uses stale-while-revalidate.

export default defineNuxtConfig({
  aiReady: {
    cacheMaxAgeSeconds: 3600 // 1 hour
  }
})
Did this page help you?