Skip to main content
Glama

get_quarto_docs

Read-only

Retrieve pages from the official Quarto documentation catalog by topic and optional version to support accurate answers about R, projects, profiles, citations, or rendering.

Instructions

Retrieve a page from the fixed catalog of official Quarto documentation.

Input Schema

NameRequiredDescriptionDefault
topicYes
quarto_versionNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds that the catalog is fixed rather than free-form search, which is useful, but says nothing about how quarto_version affects results (fallback? error?) or what happens for unsupported versions.

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

Conciseness4/5

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

A single front-loaded sentence with no filler. It is efficiently written, though the brevity comes at the cost of the missing parameter and usage detail.

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

Completeness2/5

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

An output schema exists so return values needn't be spelled out, but with both parameters undocumented and no routing against sibling doc tools, an agent lacks what it needs to call this confidently with a specific version.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the burden, yet it never mentions 'topic' or 'quarto_version'. Only indirectly does 'fixed catalog' hint that topic is a closed set; the nullable version parameter is entirely unexplained.

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

Purpose4/5

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

States a specific verb ('Retrieve') and resource ('a page from the fixed catalog of official Quarto documentation'). It is distinguishable from analysis siblings like analyze_quarto_document, but it never contrasts itself with the other doc-lookup tools (get_context7_docs, get_shiny_docs).

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

Usage Guidelines2/5

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

No guidance on when to reach for this versus get_context7_docs or the analysis/guidance siblings in the same family. The agent must infer that 'fixed catalog' means only a small known set of topics is served.

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