format_scripts
Formats Luau scripts on disk with StyLua over a synced script mirror, or reports unformatted files with check mode for use as a pre-commit gate. Scope runs to specific paths or the whole mirror.
Instructions
Format Luau on disk with StyLua (the standard Roblox formatter) over a place's synced script mirror. Default formats in place; check:true reports what's NOT formatted WITHOUT writing (a --check diff) — use it as a pre-commit gate so git diffs and snapshots stay clean. Respects a .stylua.toml in the project. Scope with paths (relative to the mirror root) or format the whole mirror. Needs StyLua installed (auto-detected or TUFAN_STYLUA_PATH).
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": "format_scripts"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| check | No | don't write — just report unformatted files (default false) | |
| paths | No | files/dirs relative to the script-mirror root (default: the whole mirror) | |
| place | No | Target place (PlaceId or project name). Defaults to the bound/sole connected place. | |
| timeoutSeconds | No | max seconds for the run (default 120, max 600) |