Get documentation for a specific Quasar UI component.

Returns the full markdown documentation including API reference, props, events, slots, methods, and usage examples.

Args:

• component (string, required): Component name. Accepts various formats:

  • With prefix: 'q-btn', 'q-input', 'q-dialog'

  • Without prefix: 'btn', 'input', 'dialog'

  • Common aliases: 'button' -> 'btn', 'modal' -> 'dialog', 'dropdown' -> 'select'

• response_format ('markdown' | 'json'): Output format (default: 'markdown')

Returns: For markdown: Full component documentation with API details For JSON: { "component": string, // Original input "normalized_name": string, // Resolved component name "path": string, // File path in docs "url": string, // Quasar.dev URL "content": string, // Documentation content "truncated": boolean // Whether content was truncated }

Examples:

• Get button docs: component="btn" or component="q-btn" or component="button"

• Get dialog docs: component="dialog" or component="modal"

• Get input docs: component="input" or component="textfield"

Errors:

• Returns "Component not found" with suggestions if component doesn't exist

Get any Quasar documentation page by its path.

Use this for non-component documentation like style guides, plugins, CLI docs, getting started guides, etc.

Args:

• path (string, required): Path to the documentation page. Examples:

  • 'vue-components/btn' - Component docs

  • 'style/color-palette' - Style documentation

  • 'quasar-plugins/notify' - Plugin docs

  • 'quasar-cli-vite/quasar-config-file' - CLI configuration

  • 'start/installation' - Getting started

• response_format ('markdown' | 'json'): Output format (default: 'markdown')

Returns: For markdown: Full page content with documentation For JSON: { "requested_path": string, // Original path input "resolved_path": string, // Actual file path found "url": string, // Quasar.dev URL "content": string, // Page content "truncated": boolean // Whether content was truncated }

Examples:

• Get color palette: path="style/color-palette"

• Get notify plugin: path="quasar-plugins/notify"

• Get CLI config: path="quasar-cli-vite/quasar-config-file"

Errors:

• Returns "Page not found" with suggestions if path doesn't exist

• Automatically tries index.md for directory paths

List all available Quasar documentation sections, or list pages within a specific section.

Use this to discover what documentation is available and navigate the docs structure.

Args:

• section (string, optional): Show pages within a specific section (e.g., 'vue-components')

• response_format ('markdown' | 'json'): Output format (default: 'markdown')

Returns: When listing all sections (no section parameter): For markdown: Formatted list of sections with titles, descriptions, and page counts For JSON: { "total_sections": number, "sections": [ { "name": string, // Section identifier (e.g., 'vue-components') "path": string, // URL path "title": string, // Human-readable title "description": string, // Section description "page_count": number // Number of pages in section } ] }

When listing pages in a section: For markdown: List of pages with titles and paths For JSON: { "section": string, "total_pages": number, "pages": [ { "title": string, "path": string, "url": string } ] }

Examples:

• List all sections: (no parameters)

• List component pages: section="vue-components"

• List plugins: section="quasar-plugins"

• Get JSON format: section="style", response_format="json"

Errors:

• Returns available sections if specified section doesn't exist

Search the Quasar documentation for topics, components, or features.

Returns a list of matching pages with titles, paths, sections, URLs, and relevance scores. Supports section filtering, pagination, and optional deep content search.

Args:

• query (string, required): Search terms (e.g., 'button', 'form validation', 'dark mode')

• section (string, optional): Limit to section (e.g., 'vue-components', 'style', 'quasar-plugins')

• limit (number): Max results 1-50 (default: 10)

• offset (number): Results to skip for pagination (default: 0)

• include_content (boolean): Search file contents - slower but more thorough (default: false)

• response_format ('markdown' | 'json'): Output format (default: 'markdown')

Returns: For markdown: Formatted list with titles, sections, paths, URLs For JSON: { "query": string, "section": string | undefined, "total": number, // Total matches found "count": number, // Results in this response "offset": number, // Current offset "limit": number, // Requested limit "has_more": boolean, // More results available "next_offset": number, // Offset for next page "results": [ { "title": string, "path": string, "section": string, "url": string, "snippet": string, // Context around match "score": number // Relevance score } ] }

Examples:

• Find button docs: query="btn"

• Find form components: query="form", section="vue-components"

• Get next page: query="dialog", offset=10, limit=10

• Deep search: query="validation", include_content=true

Errors:

• Returns "No results found" if no matches

• Returns available sections if section filter is invalid