Skip to main content
Glama

get_visualization_docs

Read-only

Retrieve exact current CRAN Rd documentation for visualization functions by package and function alias, ensuring current docs rather than historical versions.

Instructions

Get exact current CRAN Rd by alias; historical versions are not substituted.

Input Schema

NameRequiredDescriptionDefault
packageYes
functionYes
package_versionNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is covered structurally. The description adds one genuinely useful behavioral fact: the returned docs are the exact current CRAN Rd and are never silently substituted with older content. It says nothing about sourcing, failure mode when an alias doesn't exist, or latency, which with openWorldHint=true would be valuable.

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?

One compact sentence with the freshness guarantee placed second, so nothing is wasted. Brevity is slightly overstated here — the terseness is part of why the parameter story is missing — but structurally it is clean and front-loaded.

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?

With an output schema and annotations present, the bar is lower, but the description still leaves two decision-critical gaps: how this differs from get_function_docs, and whether package_version is meaningful. For a 3-parameter, enum-constrained docs lookup in a crowded sibling set, that is not enough to call it correctly with confidence.

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 must carry parameter meaning — and it doesn't. It never explains that 'function' means the Rd alias, nor what package_version does, and the statement 'historical versions are not substituted' actively conflicts with the existence of a nullable package_version parameter, leaving the agent unsure whether that argument is honored or ignored.

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

Purpose3/5

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

The verb+resource is 'Get exact current CRAN Rd', which is specific, but 'by alias' is R-documentation jargon and the tool name (get_visualization_docs) points at visualization rather than the generic CRAN Rd lookup described. Nothing distinguishes it from the sibling get_function_docs, so an agent cannot tell which one to call without guessing.

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?

The single clause 'historical versions are not substituted' implies a freshness preference but gives no when-to-use/when-not guidance and never names the obvious alternative (get_function_docs, get_context7_docs, get_package_vignettes). No prerequisites or coverage of which packages are eligible are stated in prose.

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