Getting Started
Installation
Get started with Nuxt AI in your Nuxt application.
Install the Package
Choose your preferred package manager to install Nuxt AI:
pnpm add -D @josephanson/nuxt-ai
yarn add --dev @josephanson/nuxt-ai
npm install --save-dev @josephanson/nuxt-ai
bun add -D @josephanson/nuxt-ai
Register the Module
Add the Nuxt AI module to your nuxt.config.ts:
nuxt.config.ts
export default defineNuxtConfig({
modules: ['@josephanson/nuxt-ai']
})
Configure the Module (Optional)
You can add additional configuration to enable specific features and providers:
nuxt.config.ts
export default defineNuxtConfig({
modules: ['@josephanson/nuxt-ai'],
ai: {
dev: {
client: 'cursor', // Default AI client to use
rules: true, // Default is true
}
}
})
The
client option specifies which AI client format to use for rules generation. Currently supported value is 'cursor' (default).Make sure your Nuxt development server is running (
npm run dev) before attempting to connect to the MCP server.