Skip to main content
Glama
Erodenn

Godot MCP Runtime

by Erodenn
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript

run_project

Destructive

Launch a Godot project as a child process to enable input simulation, screenshots, scripts, and debug output. Required for automated agent-driven testing sessions.

Instructions

Spawn a Godot project as a child process with stdout/stderr captured. Required before take_screenshot, simulate_input, get_ui_elements, run_script, or get_debug_output. Set profiling: true at launch to enable the profiler tools. Use attach_project for one you launched yourself. Verifies MCP bridge readiness before returning success. Returns status with the assigned bridge port. Call stop_project when done. Errors if projectPath is not a Godot project or another session is already active.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sceneNoScene to run (path relative to project, e.g. "scenes/main.tscn"). Omit to use the project's main scene.
profilingNoAttach Godot's own remote debugger so profile_project, start_profiler and stop_profiler can measure this session. Must be set at launch - a session already running cannot be profiled - and costs a little runtime overhead.
backgroundNoIf true, hides the Godot window off-screen and blocks all physical keyboard and mouse input, while keeping programmatic input (simulate_input, run_script) and screenshots fully active. Useful for automated agent-driven testing where the window should not be visible or interactive.
bridgePortNoTCP port for the MCP bridge. Omit to auto-select a free port (recommended). The chosen port is baked into the project's `mcp_bridge.gd` at inject time, so the running Godot listens on exactly this port.
projectPathYesPath to the Godot project directory

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.6.0
    • changedInput schema / properties / profiling / description
      Previous value: -"Attach Godot's own remote debugger so profile_project, start_profiler and stop_profiler can measure this session. Must be set at launch — a session already running cannot be profiled — and costs a little runtime overhead."New value: +"Attach Godot's own remote debugger so profile_project, start_profiler and stop_profiler can measure this session. Must be set at launch - a session already running cannot be profiled - and costs a little runtime overhead."
  2. Changed1 schema field changedv3.4.0
    • addedInput schema / properties / profiling
      Added value: +{
+  "description": "Attach Godot's own remote debugger so profile_project, start_profiler and stop_profiler can measure this session. Must be set at launch — a session already running cannot be profiled — and costs a little runtime overhead.",
+  "type": "boolean"
+}
  3. Addedv3.1.1
  4. Removedv3.0.0
  5. Addedv1.0.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations indicate destructiveHint=true, and the description adds rich behavioral context: stdout/stderr capture, MCP bridge readiness verification, port assignment, and explicit error conditions. It also warns that profiling must be set at launch and explains the background mode's effect on input and visibility.

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 dense but front-loaded: it starts with the core action, then dependencies, then optional features, and ends with cleanup and error conditions. Every sentence carries essential information without redundancy.

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?

Given the tool's complexity (5 parameters, no output schema), the description covers all critical aspects: prerequisites, side effects, profiling constraints, bridge port assignment, and error cases. It leaves no significant gaps for an agent to call it correctly.

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%, so baseline is 3; the description adds meaning by stating that profiling must be set at launch and that bridgePort is baked into mcp_bridge.gd. However, it does not elaborate on the scene, background, or projectPath parameters beyond what the schema provides.

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 the specific action ('Spawn a Godot project as a child process') and clarifies it as a prerequisite for multiple sibling tools, making its role unmistakable. It also distinguishes itself from attach_project by scope.

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 lists when to use this tool versus attach_project, specifies required predecessor relationships (must be called before take_screenshot, simulate_input, etc.), and provides a clear 'call stop_project when done' directive. The profiling parameter is linked to enabling profiler tools, and error conditions (invalid projectPath, active session) are stated.

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