Skip to main content
Glama

editor_job_start

Starts compile, play-mode, or open-scene operations as background editor jobs and returns immediately; continue other work, then check results with job_wait or job_status.

Instructions

Starts a long editor operation as a job and returns at once. The kinds are compile (compile the scripts and wait until the editor has reloaded and settled), play_start, play_stop, play_pause, play_resume and open_scene (path). Editor jobs run one at a time. A second job while one runs fails with job_conflict, which names the running job. Follow the job with job_wait or job_status. Its result is the result of editor_compile, editor_play_mode or editor_open_scene. Use this tool instead of those tools when the client must not wait, or when it does other work and then checks the job.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "kind": "<kind>"
    },
    "name": "editor_job_start"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindYescompile, play_start, play_stop, play_pause, play_resume or open_scene.
pathNoFor open_scene: the scene path, absolute or relative to Content/.

Output Schema

NameRequiredDescriptionDefault
kindYes
jobIdYes
startedUtcYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4.9/5.0
Behavior5/5

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

No annotations are provided, and the description carries the full behavioral burden well: it discloses the asynchronous return behavior, concurrency restriction, job_conflict failure mode, follow-up tools, and how job results map to editor_compile, editor_play_mode, or editor_open_scene.

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?

The description is front-loaded with the core purpose, then adds the essential kinds, concurrency rule, follow-up guidance, result mapping, and selection guidance. Every sentence contributes operational information without wasteful repetition.

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 complex asynchronous job tool with no annotations, this description covers the important gaps: what starts, what it returns, how jobs behave under concurrency, how to track completion, and when to prefer this over synchronous sibling tools. An output schema exists, so return-value detail is not required.

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?

Schema description coverage is 100%, so the baseline is 3. The description goes beyond the schema by explaining that kind=compile includes compiling scripts and waiting until the editor has reloaded and settled, and by associating path with open_scene; however, the play-mode kinds are not given additional detail.

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?

The description states a specific verb and resource: starts a long editor operation as a job and returns at once. It enumerates the supported job kinds and explicitly distinguishes this tool from editor_compile, editor_play_mode, and editor_open_scene.

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?

It gives explicit when-to-use guidance: use this instead of the underlying tools when the client must not wait or will do other work before checking the job. It also says to follow the job with job_wait or job_status and warns that jobs run one at a time, with a second job failing as job_conflict.

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