get_shiny_docs

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. The description adds one useful behavioral detail — that documentation is pulled from a CRAN source archive, implying a network fetch of a package tarball rather than a cached/local lookup. It says nothing about what happens if the package or version is absent, or about fetch cost.

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

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

A single front-loaded sentence with no filler. It is efficient, though the brevity is part of why usage and parameter gaps remain.

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

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

An output schema exists, so return-value explanation is not needed, and annotations carry the safety signals. What is missing is the piece an agent most needs with a near-identical sibling: routing guidance versus get_function_docs and the meaning of package_version.

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

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

Schema description coverage is 0%, so all three parameters (package, function, package_version) are undocumented in the schema. The description implies what `package` and `function` mean but never explains `package_version` — whether it pins a specific release, defaults to latest, or accepts range syntax — leaving a real gap the description should have filled.

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

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

The description states a specific verb and resource ("Get genuine Rd for a Shiny function") plus the source ("CRAN source archive"), so the agent knows this retrieves raw Rd documentation. It stops short of distinguishing itself from the sibling get_function_docs, which sounds nearly identical in purpose.

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

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

There is no statement of when to use this versus get_function_docs, get_context7_docs, or get_package_info, all of which appear to overlap. The phrase "genuine Rd" hints at raw-source retrieval but never says why an agent would pick that over rendered docs.

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