Skip to main content
Glama

get_r_workflow_guidance

Read-only

Retrieve official workflow guidance for R scenarios by combining framework documentation with package-specific knowledge for explicitly named packages.

Instructions

Combine official framework docs with knowledge for explicitly named packages.

Input Schema

NameRequiredDescriptionDefault
packagesNo
scenarioYes
r_versionNo
bioc_versionNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.4/5.0
Behavior2/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. The description adds only a thin behavioral clue that it combines official framework docs with package knowledge and works for explicitly named packages. It says nothing about the scenario-driven behavior, source boundaries, or why explicit package naming matters.

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

Conciseness3/5

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

The description is a single sentence with no fluff, so it is concise. However, for a tool with a required scenario enum and several optional parameters, it is too sparse to function as a well-structured definition, and it does not front-load the key usage or parameter context.

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 need not be described, and annotations cover safety. Even so, the description is inadequate for the tool's complexity: it omits the scenario-based nature, the required scenario values, version parameters, and the distinction from neighboring documentation and package-knowledge tools.

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 compensate for four undocumented parameters. It only indirectly mentions the packages parameter via 'explicitly named packages' and says nothing about the required scenario enum, r_version, or bioc_version. The scenario parameter is especially important and completely absent from the description.

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 description states that the tool combines official framework docs with package knowledge, which gives a rough sense of the action. However, it does not mention R workflow guidance, scenario-based guidance, or how it differs from siblings such as get_package_knowledge, get_quarto_docs, get_positron_guidance, or get_visualization_workflow. The purpose is therefore vague rather than clearly differentiated.

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?

There is no explicit guidance on when to use this tool versus the many sibling guidance/doc tools. The phrase 'for explicitly named packages' hints at package scoping but does not tell the agent when this workflow-guidance tool is the right choice or when it should use alternatives.

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