Nuxt UI

Retrieves Nuxt UI component documentation and details. Use the `sections` parameter to fetch only specific parts of the documentation to reduce response size. Use `get-component-metadata` instead when you only need structured props, slots and events.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "componentName"
  ],
  "properties": {
    "sections": {
      "type": "array",
      "items": {
        "enum": [
          "usage",
          "examples",
          "api",
          "theme",
          "changelog"
        ],
        "type": "string"
      },
      "description": "Specific sections to return: usage, examples, api, theme, changelog. If omitted, returns full documentation."
    },
    "componentName": {
      "type": "string",
      "description": "Component name. Accepts `Button`, `UButton`, `button` or `u-button`."
    }
  }
}

Retrieves metadata for a Nuxt UI component including props, slots, and events. Props are compact by default, pass `full: true` to get the raw recursive prop schemas (very large). Use this over `get-component` when you need structured props, slots and events rather than prose documentation.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "componentName"
  ],
  "properties": {
    "full": {
      "type": "boolean",
      "description": "Return raw metadata with recursive prop schemas (very large). Defaults to false (compact props)"
    },
    "componentName": {
      "type": "string",
      "description": "Component name. Accepts `Button`, `UButton`, `button` or `u-button`."
    }
  }
}

Returns the Markdown content of one documentation page by its URL path, as found in the `path` field of `search-documentation`. Pass `headings` to return only the named h2 sections and reduce response size. The result is the Markdown string only, with no metadata. A path that names a section resolves to its first page. For a component, `get-component` returns the same content with metadata. Fails when no page exists at the path.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "path"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "The path to the content page (e.g., /docs/components/button)"
    },
    "headings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Specific h2 heading titles to extract (e.g., [\"Usage\", \"API\"]). If omitted, returns full page."
    }
  }
}

Retrieves the source code of a UI example. Returns the code as a string only, without metadata. Use `list-examples` to find the exact example name.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "exampleName"
  ],
  "properties": {
    "exampleName": {
      "type": "string",
      "description": "The name of the example (PascalCase)"
    }
  }
}

Returns the full guide for migrating an application from the previous major version of Nuxt UI to this one, as Markdown with its title, description and URL. Takes no parameters and covers that single upgrade only. The page is large. To read part of it, call `get-documentation-page` with `/docs/getting-started/migration` and a `headings` list.

// inputSchema
{
  "type": "object",
  "properties": {}
}

Retrieves a template by its title (case-insensitive): description, framework, features, and links to its live preview and GitHub repository. Does not include setup instructions or source code. Use `list-templates` to find the exact title.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "templateName"
  ],
  "properties": {
    "templateName": {
      "type": "string",
      "description": "The name of the template"
    }
  }
}

Lists the names of all available UI examples. Returns names only, not code: pass a name to `get-example` to read its source.

// inputSchema
{
  "type": "object",
  "properties": {}
}

Lists the Nuxt UI templates with their full records and a `total` count. Pass `framework` to keep only templates whose framework matches exactly, ignoring case. An unknown value returns an empty list. Use this to find a template and its exact title. `get-template` returns a single template by title.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "framework": {
      "type": "string",
      "description": "Filter templates by framework (e.g., \"nuxt\", \"vue\")"
    }
  }
}

Search components by name, category, or intent. Matches alternate names from other ecosystems (e.g. "segmented control" finds FieldGroup, "combobox" finds InputMenu, "dialog" finds Modal). Results are ranked by relevance

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "search": {
      "type": "string",
      "description": "Search term to filter components by name, description, or intent (alternate names like \"segmented control\" are matched)"
    },
    "category": {
      "type": "string",
      "description": "Exact category: layout, form, element, navigation, data, overlay, dashboard, page, chat, content, editor, color-mode or i18n"
    }
  }
}

Finds Nuxt UI composables such as `useToast` or `useOverlay`. `search` is a case-insensitive substring match on the name, title and description, checked against the whole string, so pass one keyword rather than a sentence. With no `search` it lists every composable. Returns name, title, description, path and URL for each match, sorted by name. It does not return usage or signatures. Read a result with `get-documentation-page` using its `path`.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "search": {
      "type": "string",
      "description": "Single keyword, matched as a substring of the name, title or description"
    }
  }
}

Search documentation pages by title, description, or section. With no params, lists all pages.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "search": {
      "type": "string",
      "description": "Search terms to filter pages by title, path or description. Every term has to match."
    },
    "section": {
      "type": "string",
      "description": "Filter by documentation section (e.g., \"getting-started\", \"components\", \"composables\")"
    }
  }
}

Searches one Iconify collection for icons matching a keyword. One collection is searched per call, `lucide` by default, so repeat the call to try another. Returns each match as a `name` in the `i-{prefix}-{name}` format used by Nuxt UI with a `preview` SVG URL, plus the total match count.

// inputSchema
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "query"
  ],
  "properties": {
    "limit": {
      "type": "number",
      "maximum": 999,
      "minimum": 1,
      "description": "Maximum number of results (default: 64)"
    },
    "query": {
      "type": "string",
      "description": "Search query (e.g., \"arrow\", \"home\", \"settings\")"
    },
    "collection": {
      "type": "string",
      "default": "lucide",
      "description": "Icon collection to search within (e.g., \"lucide\", \"heroicons\", \"mdi\"). Defaults to \"lucide\"."
    }
  }
}