Guides

MCP Server Integration

Last updated by
Harlan Wilton
in doc: guide skeletons.

Installation

npx nuxi module add @nuxtjs/mcp-toolkit

See @nuxtjs/mcp-toolkit docs for configuration options.

Configuration

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxtjs/mcp-toolkit', 'nuxt-ai-ready'],
  mcp: {
    enabled: true,
    route: '/mcp'
  }
})

MCP configured via mcp key (from @nuxtjs/mcp-toolkit), not aiReady.

Connection

Add to Claude Desktop config:

{
  "mcpServers": {
    "my-site": {
      "command": "npx",
      "args": ["-y", "@nuxtjs/mcp-client", "https://example.com/mcp"]
    }
  }
}

Built-in Tools

list_pages

List indexed pages with search/filtering.

Parameters:

  • fields?: ['route', 'title', 'description', 'headings', 'markdown', 'id', 'chunkIds']
  • search?: Filter by title/description/route
  • limit?: Max results (default: 100)

get_page

Retrieve full page content by route.

Parameters:

  • route: Page path (e.g., /docs/installation)

Built-in Resources

pages://list

Complete page list with metadata (total + pages array).

content://all

Full site content in JSONL format for bulk export.

Built-in Prompts

browse_pages

Search pages by topic.

  • topic (required): Search keyword
  • maxResults?: Max pages (default: 10)

explain_concept

Get concept explanation from docs.

  • concept (required): Concept to explain
  • level?: beginner | intermediate | advanced

find_information

Find info with configurable detail.

  • topic (required): Topic to search
  • detail?: summary | detailed | comprehensive

Custom Definitions

Create in server/mcp/tools/, server/mcp/resources/, or server/mcp/prompts/:

server/mcp/tools/search-code.ts
import { defineMcpTool, jsonResult } from '#imports'

export default defineMcpTool({
  name: 'search_code',
  description: 'Search code examples',
  parameters: {
    type: 'object',
    properties: {
      query: { type: 'string' }
    },
    required: ['query']
  },
  handler: async ({ query }) => jsonResult({ matches: [] })
})

See @nuxtjs/mcp-toolkit docs for defineMcpResource and defineMcpPrompt.

Did this page help you?