Skip to main content
Glama

export_sourcemap

Idempotent

Generates a Rojo-style sourcemap.json from a synced script mirror so luau-lsp can resolve require paths and provide IntelliSense/type info in VS Code.

Instructions

Generate a Rojo-style sourcemap.json from a place's synced script mirror — the file luau-lsp needs to resolve require paths and give IntelliSense/type info in VS Code (and the foundation the typecheck tool will build on). Pure filesystem walk of the on-disk mirror: no Studio round-trip, no mutation. Writes to /sourcemap.json by default. Point luau-lsp at it via the luau-lsp.sourcemap.sourcemapFile setting. (Reflects scripts + folders in the mirror; non-script instances aren't on disk so aren't represented — that's all luau-lsp needs for requires.)

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

Input Schema

NameRequiredDescriptionDefault
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.
outputNooutput path (absolute, or relative to the mirror root; default sourcemap.json)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations it discloses that the operation is a pure filesystem walk with no Studio round-trip, that it writes to <mirror>/sourcemap.json by default, and that only scripts and folders on disk are represented while non-script instances are omitted. That is exactly the kind of behavioral and scope detail the annotations alone do not convey. The phrase 'no mutation' sits alongside readOnlyHint=false, but the description immediately clarifies it writes a file and mutates no place state, so this is disambiguation rather than a contradiction.

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?

One dense paragraph with the core action and output path front-loaded, followed by rationale and limitations. The parenthetical asides about luau-lsp settings and non-script instances earn their place, though the sentence about the luau-lsp.sourcemapFile setting is more setup instruction than tool behavior.

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 two-parameter, zero-required write-to-disk tool with no output schema, the description covers what is produced, where it lands, why an agent would want it, and what the output does and does not contain. Nothing needed 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.

Parameters3/5

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

Schema coverage is 100%, so both the place and output parameters are already documented, including the absolute/relative-to-mirror-root resolution and the sourcemap.json default. The description restates the default write location but adds no new syntax or format detail beyond the schema, so the 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 concrete verb and artifact: generate a Rojo-style sourcemap.json from the place's synced script mirror. It also names the downstream consumer (luau-lsp require resolution) and distinguishes itself from the sibling typecheck tool by calling itself the foundation that tool builds on.

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

Usage Guidelines4/5

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

Gives clear usage context — needed when luau-lsp must resolve require paths in VS Code, and it names the sibling (typecheck) that depends on it. It stops short of explicit when-not-to-use guidance or stating prerequisites such as needing a synced mirror to already exist, so it lands just below the top mark.

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