Skip to main content
Glama

script_check

Compile Roblox scripts to detect syntax errors and statically catch require() cycles, broken paths, and GetService() typos, with optional luau-analyze and selene checks when synced.

Instructions

Compile every script (or those under given paths) for syntax errors AND statically check require() cycles, broken require() paths, and GetService() typos. Optionally runs local luau-analyze/selene if synced.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "script_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
dirNoOptional local sync directory for luau-analyze / selene checks.
modeNofull (default): syntax + require/GetService static checks; syntax: syntax only.
pathsNoOnly scripts under these instance paths.
studioNoOptional. Target Studio (name substring, place id or id). Only needed when several Studios are open and none was selected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the whole burden and does disclose key behavior: it compiles scripts inside Studio, static-analyzes requires and GetService calls, may invoke local luau-analyze/selene only when a sync directory is available, and needs a Studio target when several are open. It stops short of stating that scripts are not modified and how failures are reported.

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?

Front-loaded with the primary action and scoping, then a short second sentence on the optional external analyzers. Dense but readable with no filler; the trailing fragment is slightly clipped.

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 multi-check tool with four parameters, no annotations, and no output schema, the definition never explains the shape of results (per-script diagnostics, counts, failure reporting), which is the main remaining gap. It is otherwise adequate.

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 coverage is 100%, so dir, mode, paths, and studio are already documented; the description only adds the linkage that dir gates the optional luau-analyze/selene run. Baseline 3 is appropriate since the schema does the heavy lifting.

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 specific verbs ('compile', 'statically check') and the exact resources/checks: syntax errors, require() cycles, broken require() paths, GetService() typos. This clearly separates it from sibling read/edit/grep tools that touch scripts.

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 by the check-oriented purpose and the mode/paths scoping, but there is no explicit when-to-use or when-not guidance relative to alternatives, and no statement about prerequisites beyond the passing mention of 'if synced'.

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