Skip to main content
Glama

list_practices

Retrieve R coding best practices filtered by workflow, category, severity, tags, enforcement type, or free-text query.

Instructions

List best practices, optionally filtered by workflow, category, minimum severity, tags, enforcement type (automated check or guidance only) or free-text query

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagsNoOnly practices having at least one of these tags (REST: comma separated list)
limitNoMaximum number of practices to return (1-200). On /api/v1 this is the page size, capped at 100.
queryNoCase-insensitive text search over id, title, description, details and tags (REST alias: q)
categoryNoOptional category (structure, naming, documentation, etc.)
workflowNoOptional workflow type (r-script, quarto, shiny, package, etc.)
enforcementNo'automated' = a validator rule reports violations; 'guidance' = advice only
minSeverityNoOnly practices at least this severe (critical > important > recommended > info)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It does not state that this is a safe read-only operation, how results are ordered, how pagination beyond the limit works, or what the response contains for a 7-parameter tool. The only behavioral clue, the parenthetical clarifying enforcement semantics, describes a parameter rather than tool behavior.

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 that enumerates the filter dimensions with no filler. It is efficient, though the parenthetical 'automated check or guidance only' is slightly redundant against the schema enum.

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

Completeness3/5

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

For a 7-parameter list tool with no output schema and no annotations, the description covers the filter surface but omits retrieval behavior, ordering, and return shape. It is minimally adequate for an agent to pick the tool but not complete enough to predict results.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents every parameter including enum meanings and tag combination logic, making 3 the baseline. The description merely restates the available filters without adding format, matching, or combination semantics beyond the schema.

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 (List) and resource (best practices) with the full set of filtering dimensions. It is clearly distinguished from the singular get_practice sibling, though the relationship is implied rather than named.

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 word 'optionally' signals that all filters are optional, but there is no explicit when-to-use guidance, no statement of what this offers over get_practice or detect_workflow, and no exclusions. Usage must be inferred.

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