Skip to main content
Glama

sync_sourcemap

Generate a Rojo-compatible sourcemap.json and optional .luaurc from Studio so Luau LSP, luau-analyze, and coding agents resolve require() paths and instances.

Instructions

Generate a Rojo-compatible sourcemap.json (and optional .luaurc) from Studio so Luau LSP, luau-analyze, and coding agents resolve require() paths and instances.

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": "sync_sourcemap"
  }
}

Input Schema

NameRequiredDescriptionDefault
dirNoSynced scripts folder. Default ./roblox-src.
outNoOutput path. Default ./sourcemap.json.
luaurcNoCreate .luaurc if missing. Default false.
studioNoOptional. Target Studio (name substring, place id or id). Only needed when several Studios are open and none was selected.
max_depthNoInstance hierarchy depth. Default 6.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It does disclose useful behavior: it writes sourcemap.json to a path and only creates .luaurc 'if missing', which signals a non-destructive default. However, it never says whether an existing sourcemap.json is overwritten, whether a live Studio connection is required, or what happens if Studio is absent — notable gaps for a file-writing tool.

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?

One dense sentence, front-loaded with the produced artifact and justified by its consumers; nothing is wasted or repeated from the schema.

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

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a five-parameter, all-optional file-generation tool with a fully documented schema and no output schema, the description covers what is produced and why. The main residual gap is mutation semantics (overwrite behavior, Studio connectivity requirements), which keeps it short of fully complete.

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 every parameter including its default is already documented in the schema. The description adds no syntax, format, or interaction detail beyond mentioning the optional .luaurc artifact, so baseline 3 applies.

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 and artifact: 'Generate a Rojo-compatible sourcemap.json (and optional .luaurc) from Studio,' plus the downstream consumer (Luau LSP, luau-analyze, coding agents). An agent can tell this is a codegen/export tool and not a sync or read tool without opening the schema.

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?

The stated purpose implies when it is useful (setting up require() path resolution), but there is no explicit when-to-use, when-not-to-use, or routing to siblings like sync_pull or sync_status. Guidance is inferred rather than stated.

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