Skip to main content
Glama

Get Checks

get_checks

Retrieve SystemDox checks for banned patterns, required patterns, and coding rules, filtering by language, category, or file path so agents get only relevant checks.

Instructions

Retrieve SystemDox checks (banned patterns, required patterns, coding rules). Filter by language, category, or file path to get only relevant checks.

Input Schema

NameRequiredDescriptionDefault
categoryNoFilter by category (imports, auth, error-handling, architecture, testing, security, conventions, data-access)
languageNoFilter by programming language (python, typescript, javascript, cloudformation)
file_pathNoFile path being edited — language is auto-detected from the extension

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. The verb "Retrieve" does disclose that this is a non-mutating read, but the description says nothing about default behavior with zero filters, result volume, ordering, or truncation limits.

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?

Two short sentences, front-loaded with the resource and followed by the filtering capability; no filler. It could be tightened slightly by making the relationship between the filters (can they combine?) explicit rather than implied.

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 simple, all-optional-parameter read tool with no output schema, the definition covers what is fetched and how to narrow it, which is adequate. It omits the unfiltered default case and any sense of result shape, which are the remaining gaps for correct invocation.

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 all three filters with enumerated example values (and even notes that file_path auto-detects language). The description merely restates the same three filter dimensions, so it adds no meaning beyond the schema — the baseline 3 applies.

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?

The description uses a specific verb ("Retrieve") plus a concrete resource (SystemDox checks) and parenthetically defines what a check is (banned patterns, required patterns, coding rules). It does not, however, distinguish this tool from nearby siblings like get_guardrails or get_project_rules, which sound conceptually adjacent.

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?

It states the three filtering axes (language, category, file path) and the goal of narrowing to relevant checks, which implies usage. It never says when to choose this over get_guardrails / get_project_rules, or what happens if no filter is supplied, leaving the selection decision to inference.

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