Skip to main content
Glama
playcanvas

PlayCanvas Editor MCP Server

Official
by playcanvas

launch_start

Launch a real runtime instance of the current PlayCanvas scene to execute scripts, physics, animation, and input. Returns a session ready for runtime capture and logging.

Instructions

Start a real Launch runtime instance of the current scene (the editor's Launch button) so scripts, physics, animation and input actually run. Opens the launch page in a new browser window with debug logging on; the editor bridges it automatically. Returns { url, sceneId, ready, adopted, engineVersion, device, deviceType, sessionId } where ready=true means the runtime is usable by capture_runtime / read_runtime_logs, and adopted=true means it attached to an app that was already running instead of starting a new one (which happens only when no options are passed, so pass an option to force a fresh launch). engineVersion is the exact version the app launched with (null when adopting an app of unknown origin), device is the requested override, deviceType is the backend the runtime actually created (webgpu/webgl2/webgl1), and sessionId changes on every launch so you can tell a fresh launch from a re-used one. This is the prerequisite for all runtime tools. If ready=false, the page may still be loading or popups were blocked; poll read_runtime_logs or retry. When NOT to use: to screenshot the editor (use capture_viewport); to change the scene (edit-time tools).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
debugNo
deviceNoGraphics device to launch with (default: project setting)
waitMsNoHow long to wait for the runtime to connect before returning (default 20000)
bundlesNo
profilerNo
miniStatsNo
concatenateNo
engineVersionNoEngine channel (current | previous | releaseCandidate) or an exact available version; omit to use the Editor's own selection (the Launch button "Use Release Candidate" option, else the session engine-version setting). list_engine_versions reports both.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.7.1
    • addedInput schema / properties / engineVersion / description
      Added value: +"Engine channel (current | previous | releaseCandidate) or an exact available version; omit to use the Editor's own selection (the Launch button \"Use Release Candidate\" option, else the session engine-version setting). list_engine_versions reports both."
  2. Addedv0.7.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations cover only the safety profile (readOnly=false, openWorld=true, idempotent=false). The description adds substantial behavior beyond that: it opens a browser window, popups can be blocked, the editor auto-bridges, adopted=true only occurs when no options are passed, and sessionId changes per launch. This is the kind of context the structured fields cannot carry.

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 prerequisite status are front-loaded, and the return-field explanation is dense but earns its space. It runs long with several clauses, but almost nothing is filler; a slight trim of the return-value enumeration would tighten it.

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?

With no output schema, the description carries the return contract well ({url, sceneId, ready, adopted, engineVersion, device, deviceType, sessionId}) plus failure modes and adoption semantics. The main remaining gap is the undocumented boolean launch flags, which an agent might need to pass.

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 only 38% across 8 params. The description does add meaning for device (requested override), engineVersion, and the 'no options passed' adoption rule, but debug, bundles, profiler, miniStats, concatenate and waitMs are left undocumented in both schema and description. Baseline 3 given the partial compensation.

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+resource ('Start a real Launch runtime instance of the current scene') and anchors it to the concrete editor affordance ('the editor's Launch button'). It also declares its systemic role ('the prerequisite for all runtime tools'), which no sibling shares, so the agent can distinguish it immediately.

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?

Explicitly names when NOT to use it ('to screenshot the editor use capture_viewport; to change the scene use edit-time tools') and routes siblings (capture_runtime, read_runtime_logs) as downstream consumers. It also gives a recovery path when ready=false (poll read_runtime_logs or retry) and explains how to force a fresh launch.

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

Deploy Server

Other Tools