Skip to main content
Glama
Sign In
Godot MCP - Full Control

Godot MCP - Full Control

by cxb2523
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

read_scene

Reads a Godot scene file and returns its node hierarchy as JSON for headless inspection and analysis.

Instructions

Read scene file as JSON node tree (headless)

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": {
      "projectPath": "<projectPath>",
      "scenePath": "<scenePath>"
    },
    "name": "read_scene"
  }
}

Input Schema

NameRequiredDescriptionDefault
scenePathYesScene file path (relative to project)
projectPathYesGodot project path

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.1.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations are absent, so the description carries the full burden of behavioral disclosure. The word 'headless' adds useful context (it reads the file without launching the editor/game), and 'Read' implies a non-destructive operation. However, the description does not disclose error behavior (missing file, invalid scene), whether binary .scn scenes are supported, how inherited scenes or ext_resource references are handled, or any project-load prerequisites.

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?

The description is seven words and every word earns its place: verb, object, output format, and mode (headless). It is appropriately front-loaded for a simple read tool. It could afford one additional sentence of behavioral or usage context without becoming bloated, but as written it is efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and no annotations, the description is the sole source of return-value and safety information. 'JSON node tree' conveys the general shape but not the structure (root node, properties, transforms, scripts, connections), and this is a Godot-specific format with edge cases (binary scenes, inherited scenes, sub-resources). Against a very large sibling set and zero structured enrichment, a 7-word description leaves material gaps for an agent calling this tool correctly.

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 description coverage is 100% — both projectPath and scenePath have concise descriptions in the schema, so the baseline is 3. The tool description adds no parameter-level meaning beyond the schema: it does not clarify whether projectPath should be absolute or point at the directory containing project.godot, nor whether scenePath requires the file extension. The description neither hurts nor improves on the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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: 'Read scene file as JSON node tree (headless)'. It clearly conveys what the tool does and the output format. However, it does not explicitly differentiate from siblings like game_get_scene_tree (which reads the live runtime tree) — the 'headless' qualifier hints at reading from disk, but the distinction is implicit rather than stated.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. With roughly 190 siblings including game_get_scene_tree, read_file, modify_scene_node, and save_scene, an agent receives no help choosing between reading the file from disk (headless) versus reading the live scene tree, or between this and a generic file read. The description gives no context, exclusions, or alternative routing.

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