Skip to main content
Glama

editor_compile

Compile project scripts in the open Flax editor and return after script reload settles, reporting structured errors or the reload outcome.

Instructions

Compiles the project's scripts and returns when the editor has reloaded and settled. First, the tool compiles the scripts outside the editor with the compiler arguments that Flax.Build last used (build_check_scripts). Errors come back at once, structured (file, line, column, code), and the editor does not change. After a clean check, the tool stops play mode and the editor compiles. The outcome is reloaded, unchanged or failed (build tool lines in BuildErrors). Check tells how the check went: passed, failed, or unavailable with the reason. Use this tool when the editor is open. With no editor, use build_compile_scripts. To find errors without a change in the editor, use build_check_scripts.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
checkNo
errorsYes
outcomeYes
reloadsYes
secondsYes
buildErrorsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so: it discloses that the check phase leaves the editor untouched, that a clean check stops play mode, and that outcomes are reloaded/unchanged/failed with BuildErrors lines. The play-mode side effect is exactly the kind of destructive detail an agent needs before calling.

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?

Purpose and the two phases are front-loaded, and every clause carries information. Some sentences are telegraphic to the point of being clipped ('Check tells how the check went'), which costs a little readability but not correctness.

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?

An output schema exists, yet the description still summarizes the meaningful return distinctions (reloaded/unchanged/failed, check passed/failed/unavailable), and it covers the prerequisites and side effects of a fairly complex multi-stage operation. Nothing essential is missing.

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

Parameters4/5

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

The tool takes no parameters, so there is nothing to disambiguate and the baseline applies. The description correctly implies a zero-argument invocation rather than suggesting configuration options that do not exist.

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 resource (compiles the project's scripts) and precisely describes the two-phase behavior: an out-of-editor check with Flax.Build's last compiler arguments, then an in-editor compile and reload. It is clearly distinguishable from siblings build_compile_scripts and build_check_scripts.

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?

Explicit routing is given: use when the editor is open; with no editor use build_compile_scripts; to find errors without an editor change use build_check_scripts. When-to-use, when-not, and named alternatives are all present.

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