Skip to main content
Glama

check_project

Read-onlyIdempotent

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.

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

NameRequiredDescriptionDefault
pathsNo

Output Schema

NameRequiredDescriptionDefault
codeNo
engineNo
statusYes
checkIdNo
enginesNo
messageNo
clustersNo
nextStepNo
retryableNo
truncatedNo
filteredOutNo
loopWarningNo
projectRootNo
totalIssuesNo
schemaVersionNo
remainingIssuesNo
filteredOutCountNo
omittedIssueCountNo
fileRuleChurnWarningNo
filteredOutIssueCountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv1.0.1
    • addedOutput schema / additionalProperties
      Added value: +false
    • changedOutput schema / properties / clusters / items / required
      Previous value: -[
      -  "clusterId",
      -  "rootCauseSummary",
      -  "ruleIds",
      -  "issueCount",
      -  "fileCount",
      -  "priority",
      -  "suggestedAction",
      -  "sampleIssueIds"
      -]New value: +[
      +  "clusterId",
      +  "rootCauseSummary",
      +  "ruleIds",
      +  "issueCount",
      +  "fileCount",
      +  "priority"
      +]
    • changedOutput schema / properties / engine / enum
      Previous value: -[
      -  "oxlint",
      -  "tsc",
      -  "biome",
      -  "eslint"
      -]New value: +[
      +  "oxlint",
      +  "tsc",
      +  "biome",
      +  "eslint",
      +  "external-lsp",
      +  "vscode",
      +  "all"
      +]
    • addedOutput schema / properties / engines / properties / external-lsp
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "message": {
      +      "type": "string"
      +    },
      +    "status": {
      +      "enum": [
      +        "ok",
      +        "error",
      +        "disabled"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / engines / properties / vscode
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "message": {
      +      "type": "string"
      +    },
      +    "status": {
      +      "enum": [
      +        "ok",
      +        "error",
      +        "disabled"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status"
      +  ],
      +  "type": "object"
      +}
    • removedOutput schema / properties / engines / required
      Removed value: -[
      -  "oxlint",
      -  "tsc",
      -  "biome",
      -  "eslint"
      -]
    • addedOutput schema / properties / filteredOut
      Added value: +{
      +  "type": "integer"
      +}
    • addedOutput schema / properties / filteredOutCount
      Added value: +{
      +  "type": "integer"
      +}
    • addedOutput schema / properties / filteredOutIssueCount
      Added value: +{
      +  "type": "integer"
      +}
    • addedOutput schema / properties / nextStep
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / omittedIssueCount
      Added value: +{
      +  "type": "integer"
      +}
    • addedOutput schema / properties / remainingIssues
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "col": {
      +        "type": "integer"
      +      },
      +      "file": {
      +        "type": "string"
      +      },
      +      "fixable": {
      +        "type": "boolean"
      +      },
      +      "issueId": {
      +        "type": "string"
      +      },
      +      "line": {
      +        "type": "integer"
      +      },
      +      "priority": {
      +        "type": "integer"
      +      },
      +      "rule": {
      +        "type": "string"
      +      },
      +      "severity": {
      +        "enum": [
      +          "error",
      +          "warning"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "issueId",
      +      "file",
      +      "line",
      +      "col",
      +      "rule",
      +      "severity",
      +      "fixable"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / retryable
      Added value: +{
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / schemaVersion / enum
      Previous value: -[
      -  "1.3"
      -]New value: +[
      +  "1.3",
      +  "1.4"
      +]
    • changedOutput schema / properties / status / enum
      Previous value: -[
      -  "clean",
      -  "issues_found",
      -  "error"
      -]New value: +[
      +  "clean",
      +  "issues_found",
      +  "error",
      +  "stale"
      +]
  2. 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"
      +]
  3. 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"
      +]
  4. 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"
      +}
  5. First observedv0.3.3

TDQS

A4.8/5.0
Behavior4/5

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

The annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world behavior, and the description reinforces read-only operation while adding useful context: no caching, re-running all enabled engines each call, optional Biome, clustering, and path-validation error responses. It does not discuss runtime cost or result shape beyond what the output schema likely covers.

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?

The description is front-loaded with the core action and engine details, then covers behavior, parameter constraints, and the sibling alternative. Every sentence contributes directly to correct invocation or tool selection.

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?

For a one-parameter tool with annotations covering safety and an output schema covering return values, the description supplies everything an agent needs: engine scope, read-only behavior, path rules, caching behavior, and the alternative for incremental checks.

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

Parameters5/5

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

With 0% schema description coverage and one optional parameter, the description fully compensates: it explains that paths default to the project root when omitted, must be relative and within the project directory, and that absolute or out-of-root paths return an error. This adds substantial semantics beyond the bare array schema.

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?

The description states a specific verb and resource: it runs and clusters Oxlint, TypeScript, and optionally Biome lint/type diagnostics across project paths. It also explicitly distinguishes itself from the sibling check_files tool, so an agent can select it 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?

It gives clear when-to-use guidance: 'Use this for a full project scan; use check_files instead for faster incremental checks after editing specific files.' It also states the default path behavior and the error condition for absolute or out-of-root paths.

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