Getting Started
Configuration
Nuxt AI can be configured with several options.
To configure the Nuxt AI module and customize its behavior, you can use the ai
property in your nuxt.config
:
nuxt.config.ts
export default defineNuxtConfig({
ai: {
// Options
}
})
Core Configuration
MCP Server Configuration
The Model Context Protocol (MCP) server provides additional development tools and can be configured with the mcp
option.
mcp.enabled
Toggle the MCP server on or off. Default is true
in development and false
in production.
nuxt.config.ts
export default defineNuxtConfig({
ai: {
dev: {
mcp: {
enabled: true
}
}
}
})
dev.rules
Enable AI assistant rules files within your project, these files are used to generate rules for the AI assistant.
nuxt.config.ts
export default defineNuxtConfig({
ai: {
dev: {
client: 'cursor', // Set the AI assistant client
rules: true // Enable AI assistant rules
}
}
})
📚 See supported clients: Explore the clients supported by the module here.
We recommend ignoring the generated rules files in your
.gitignore
file.