Skip to main content
Glama
playcanvas

PlayCanvas Editor MCP Server

Official
by playcanvas

query_runtime_state

Read-only

Read live entity state from the running Launch instance to verify play-mode behavior directly—positions, rotations, rigidbody velocities, and UI text—without guessing from screenshots.

Instructions

Read the LIVE runtime state of entities in the RUNNING Launch instance — the non-visual ground-truth read-back for verifying play-mode behaviour without guessing screenshot timing. Requires launch_start first. For each matched entity returns world position, local position, euler rotation, scale, enabled, component names, plus rigidbody (type/mass/linearVelocity/angularVelocity) and element (type/text, e.g. a HUD score label) when present. Filter with ids (editor resource_ids — the runtime uses the same GUIDs) or name (case-insensitive substring); omit both to page through every entity. Paginated via limit (default 50) + offset (meta has total/count/hasMore/nextCursor). Use this to answer questions the camera cannot: "did the ball actually move / fall through the floor?", "is the rigidbody simulating (velocity != 0)?", "what does the score HUD say?". An empty result is success, not an error. When NOT to use: for edit-time scene data (use list_entities); before launch_start; to change state (use modify_entities / inject_input).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNoEntity resource_ids to inspect (same GUIDs as edit-time). Omit to filter by name or list all.
nameNoFilter by entity name (case-insensitive substring)
limitNoMax entities to return (default 50)
offsetNoEntities to skip (use nextCursor from a previous page)
Behavior5/5

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

Annotations already mark readOnlyHint=true, and the description reinforces this with 'Read' and clarifies important behavioral details: it requires launch_start first, empty results indicate success rather than error, the runtime shares the same GUIDs as edit-time, and it returns specific fields including rigidbody and element data when present. This is substantial beyond what annotations alone provide.

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 long but intentionally so, given the tool's complexity and the absence of an output schema. It is front-loaded with the core purpose, then covers return fields, filtering, pagination, use-case examples, and exclusions in a logical order with no filler or 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 runtime inspection tool with no output schema, the description is comprehensive: it explains prerequisites, return contents, filtering semantics, pagination metadata, success semantics, and alternatives. An agent has everything needed to decide when to call it and what to expect in response.

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 coverage is 100% and each parameter already has a clear description in the schema. The tool description adds useful context beyond the schema, such as omitting both filters to page through every entity, the runtime using the same GUIDs, and the meaning of offset via nextCursor, though most parameter semantics are already well documented in the schema.

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 ('Read'), a precise resource ('LIVE runtime state of entities in the RUNNING Launch instance'), and distinguishes this from edit-time scene data by calling it the 'non-visual ground-truth read-back'. It also explicitly contrasts with sibling tools like list_entities and query_viewport_state, making its purpose unambiguous.

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?

The description gives clear when-to-use guidance with concrete example questions ('did the ball actually move?', 'is the rigidbody simulating?'), and an explicit 'When NOT to use' section naming list_entities, pre-launch usage, and modify_entities/inject_input. It also states the prerequisite launch_start and explains when to use ids vs name vs neither.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/playcanvas/editor-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server