Skip to main content
Glama
mamit514

quasar-docs-mcp-server

by mamit514

quasar_search_docs

Search Quasar documentation to find topics, components, and features. Results include titles, paths, URLs, and relevance scores with optional section filtering and deep content search.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of results to return (default: 10, max: 50)
queryYesSearch query (e.g., 'button', 'form validation', 'dark mode')
offsetNoNumber of results to skip for pagination (default: 0)
sectionNoOptional: limit search to a specific section (e.g., 'vue-components', 'style', 'quasar-plugins')
include_contentNoWhether to search within file contents (slower but more thorough)
response_formatNoOutput format: 'markdown' for human-readable or 'json' for machine-readablemarkdown
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It comprehensively discloses behavior: pagination (limit, offset, has_more, next_offset), optional deep content search (include_content), error messages ('No results found', invalid section), and return format details. This covers all critical traits for effective use.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with labeled sections (Args, Returns, Examples, Errors), front-loaded with the core purpose, and each sentence adds value. It is appropriately sized for the complexity (6 parameters, pagination, two output formats) and does not include unnecessary repetition or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description fully compensates by detailing the return structure for both markdown and JSON, including fields like total, has_more, snippet, score. It covers pagination, error handling, and provides comprehensive examples. The tool is search-based with moderate complexity, and the description addresses all necessary context for an agent to select and invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but the description adds significant value beyond the schema. It lists parameters with their roles, provides examples of usage, explains the effect of include_content, details the return structure for both markdown and JSON, and specifies default values and constraints. The examples alone (e.g., 'Find button docs: query="btn"') greatly enhance understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Search the Quasar documentation for topics, components, or features.' It uses a specific verb ('Search') and resource ('Quasar documentation'), and the action is distinct from sibling tools (quasar_get_component, quasar_get_page) which retrieve individual items rather than searching.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool (searching documentation) through examples and parameter descriptions. However, it does not explicitly contrast with sibling tools or state when not to use it (e.g., when you know the exact component name, prefer quasar_get_component). The examples implicitly cover various use cases but lack explicit exclusion guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mamit514/quasar-docs-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server