Skip to main content
Glama

check_project

Read-onlyIdempotent

Run Oxlint, TypeScript, and optional Biome lint/type diagnostics across project paths, cluster repeated issues, and scan without writing files. Use for full scans, not incremental checks.

Instructions

Runs and clusters Oxlint and TypeScript (and optionally Biome) lint and type diagnostics for one or more project paths. Read-only; no files are written or modified. Paths default to the project root (".") when omitted; paths must be relative and within the project directory — absolute paths or paths outside the root return an error response. Use this for a full project scan; use check_files instead for faster incremental checks after editing specific files. Each call re-runs all enabled engines with no caching.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeNo
engineNo
statusYes
checkIdNo
enginesNo
messageNo
clustersNo
truncatedNo
loopWarningNo
projectRootNo
totalIssuesNo
schemaVersionNo
fileRuleChurnWarningNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv1.0.0
    • addedOutput schema / properties / checkId
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / engine / enum
      Previous value: -[
      -  "oxlint",
      -  "tsc",
      -  "biome"
      -]New value: +[
      +  "oxlint",
      +  "tsc",
      +  "biome",
      +  "eslint"
      +]
    • addedOutput schema / properties / engines / properties / eslint
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "message": {
      +      "type": "string"
      +    },
      +    "status": {
      +      "enum": [
      +        "ok",
      +        "error",
      +        "disabled"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status"
      +  ],
      +  "type": "object"
      +}
    • changedOutput schema / properties / engines / required
      Previous value: -[
      -  "oxlint",
      -  "tsc",
      -  "biome"
      -]New value: +[
      +  "oxlint",
      +  "tsc",
      +  "biome",
      +  "eslint"
      +]
    • addedOutput schema / properties / projectRoot
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / schemaVersion / enum
      Previous value: -[
      -  "1.2"
      -]New value: +[
      +  "1.3"
      +]
    • changedOutput schema / properties / status / enum
      Previous value: -[
      -  "clean",
      -  "issues_found",
      -  "timeout",
      -  "error"
      -]New value: +[
      +  "clean",
      +  "issues_found",
      +  "error"
      +]
  2. Changed2 schema fields changedv0.4.0
    • addedOutput schema / properties / fileRuleChurnWarning
      Added value: +{
      +  "oneOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "checkCount": {
      +          "type": "integer"
      +        },
      +        "file": {
      +          "type": "string"
      +        },
      +        "hint": {
      +          "type": "string"
      +        },
      +        "rule": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "file",
      +        "rule",
      +        "checkCount",
      +        "hint"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • changedOutput schema / properties / schemaVersion / enum
      Previous value: -[
      -  "1.1"
      -]New value: +[
      +  "1.2"
      +]
  3. Changed1 schema field changedv0.3.7
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "clusters": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "clusterId": {
      +            "type": "string"
      +          },
      +          "fileCount": {
      +            "type": "integer"
      +          },
      +          "issueCount": {
      +            "type": "integer"
      +          },
      +          "priority": {
      +            "type": "integer"
      +          },
      +          "rootCauseSummary": {
      +            "type": "string"
      +          },
      +          "ruleIds": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "sampleIssueIds": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "suggestedAction": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "clusterId",
      +          "rootCauseSummary",
      +          "ruleIds",
      +          "issueCount",
      +          "fileCount",
      +          "priority",
      +          "suggestedAction",
      +          "sampleIssueIds"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "code": {
      +      "type": "string"
      +    },
      +    "engine": {
      +      "enum": [
      +        "oxlint",
      +        "tsc",
      +        "biome"
      +      ],
      +      "type": "string"
      +    },
      +    "engines": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "biome": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "message": {
      +              "type": "string"
      +            },
      +            "status": {
      +              "enum": [
      +                "ok",
      +                "error",
      +                "disabled"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "status"
      +          ],
      +          "type": "object"
      +        },
      +        "oxlint": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "message": {
      +              "type": "string"
      +            },
      +            "status": {
      +              "enum": [
      +                "ok",
      +                "error",
      +                "disabled"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "status"
      +          ],
      +          "type": "object"
      +        },
      +        "tsc": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "message": {
      +              "type": "string"
      +            },
      +            "status": {
      +              "enum": [
      +                "ok",
      +                "error",
      +                "disabled"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "status"
      +          ],
      +          "type": "object"
      +        }
      +      },
      +      "required": [
      +        "oxlint",
      +        "tsc",
      +        "biome"
      +      ],
      +      "type": "object"
      +    },
      +    "loopWarning": {
      +      "oneOf": [
      +        {
      +          "additionalProperties": false,
      +          "properties": {
      +            "hint": {
      +              "type": "string"
      +            },
      +            "occurrences": {
      +              "type": "integer"
      +            },
      +            "signature": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "signature",
      +            "occurrences",
      +            "hint"
      +          ],
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "schemaVersion": {
      +      "enum": [
      +        "1.1"
      +      ],
      +      "type": "string"
      +    },
      +    "status": {
      +      "enum": [
      +        "clean",
      +        "issues_found",
      +        "timeout",
      +        "error"
      +      ],
      +      "type": "string"
      +    },
      +    "totalIssues": {
      +      "type": "integer"
      +    },
      +    "truncated": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "status"
      +  ],
      +  "type": "object"
      +}
  4. First observedv0.3.3

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds genuinely new behavior: paths are validated against the project root with an error response for absolute/outside-root paths, and every call re-runs all enabled engines with no caching. That caching and error-semantics detail is exactly the kind of context annotations cannot convey.

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

Conciseness5/5

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

Four sentences, front-loaded with the core action, then the read-only guarantee, then path constraints, then the sibling routing. Every sentence carries distinct information with no padding.

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

Completeness5/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 no explanation. For a single-optional-parameter read-only scan tool, the description covers defaults, constraints, error behavior, caching semantics, and sibling routing — nothing an agent needs to call it correctly is missing.

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

Parameters4/5

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

The single paths parameter has 0% schema description coverage, so the description must compensate, and it does: default of "." when omitted, relative-only requirement, must be within the project directory, and error behavior otherwise. It stops short of describing ordering or the 512 maxItems cap, so it is not fully exhaustive.

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

Purpose5/5

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

States a specific verb+resource: runs and clusters Oxlint and TypeScript lint/type diagnostics over project paths. It explicitly names the sibling it is not (check_files) and defines the scope (full project scan) versus incremental checks, so an agent can disambiguate without opening either schema.

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

Usage Guidelines5/5

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

Gives explicit when-to-use (full project scan) and when-to-use-the-alternative (check_files for faster incremental checks after editing specific files). It also covers defaults when paths are omitted and the constraint that paths must be relative and inside the project root.

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