Skip to main content
Glama

validate_project

Validate an R project against best practices, returning findings by severity and category. If no project type is detected, warnings indicate no checks ran.

Instructions

Validate an R project against best practices. Optional filters narrow the returned findings; the summary always counts all findings. If no project type is detected the result has no findings and a warnings array: that means no checks ran, not that the project is clean.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesDirectory path to validate
workflowNoOptional workflow type (auto-detected if omitted)
categoriesNoOnly return findings in these categories (omit for all categories)
maxFindingsNoReturn at most this many findings after other filters (1-1000). The summary still counts all findings.
minSeverityNoOnly return findings at least this severe (critical > important > recommended > info)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.7/5.0
Behavior4/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, and it does meaningful work: it warns that filtered findings do not change the summary counts, and that a missing project-type detection yields empty findings plus a warnings array — i.e. no checks ran rather than a clean bill of health. That non-obvious disclosure prevents a serious misread; it stops short of describing severity semantics or output shape in depth.

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?

Three sentences, front-loaded with the core purpose and then the two highest-value caveats. The final sentence is long but earns its length by preventing the 'no findings = clean' misinterpretation.

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

Completeness4/5

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

No output schema exists, so the description must hint at returns, and it does (findings, summary, warnings array). For a read-only validation tool with fully documented parameters, this is close to complete; only severity semantics and the findings record shape are left unstated.

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 baseline is 3. The description reinforces that filters (categories, minSeverity, maxFindings) narrow returned findings while the summary still totals everything, but this largely restates what the maxFindings schema already says, adding little 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 clear verb+resource: 'Validate an R project against best practices.' Scope ('project', not file) implicitly distinguishes it from the sibling validate_file, though it never names that sibling explicitly.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the description covers how filters behave and one edge case, but gives no guidance on when to reach for this tool versus validate_file or detect_workflow. An agent must infer the selection criteria.

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