Godot Playtester MCP
MCP server that embeds inside Godot 4 games โ AI agents can inspect, control, and test running games in real-time
Ask AI about Godot Playtester MCP
Powered by Claude ยท Grounded in docs
I know everything about Godot Playtester MCP. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
Godot Playtester MCP
Embed an MCP server into your Godot 4 (.NET) game, let AI agents play and test it.
โโโโโโโโโโโโโโโโ HTTP โโโโโโโโโโโโโโโโโโโ
โ AI Agent โโโโโโโโโโโโโโโโโโโโโโโบโ Godot Game โ
โ (Claude) โ localhost:9876 โ (running) โ
โ โ โ โ
โ read state โ get_game_state โโโบโ player HP 85 โ
โ click UI โ click_element โโโโบโ button pressed โ
โ press key โ press_key โโโโโโโโบโ W key held โ
โ run macros โ execute_macro โโโโบโ auto-battle 30s โ
โ screenshot โ screenshot โโโโโโโบโ [base64 image] โ
โโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ
What It Does
AI agents connect to your running Godot game and can:
| Capability | Examples |
|---|---|
| Read game state | Player position, enemy HP, item locations, distances |
| Control UI | Click buttons, type text, drag items, select options |
| Simulate input | Keyboard (WASD), mouse click/move/scroll, combos |
| Run macro scripts | Auto-battle, walk paths, repeat actions, timed sequences |
| Monitor metrics | HP over time, score curves, frame rate |
| Capture visuals | Screenshots for layout verification |
| Read/write logs | Three-tier logging (AI log, file log, debug log) |
| Run automated tests | Balance testing, regression, QA scenarios |
34 built-in tools covering state query, UI control, input simulation, macro execution, metrics, testing, and logging.
Quick Start (3 steps)
Step 1 โ Copy 14 C# files into your project:
cp src/*.cs <your_project>/addons/game_mcp/
Step 2 โ Register as Autoload in Godot:
Project Settings โ Autoload โ Add GameMcpServer.cs
Step 3 โ Tag your game objects:
public override void _Ready()
{
AddToGroup("player"); // one line, that's it
}
Run the game. MCP server starts on http://localhost:9876. Done.
Zero-Intrusion Design
- No base classes to inherit, no architecture changes, no dependencies
- Game code runs exactly as before โ MCP is a passive observer
- Minimal changes: tag objects with Groups + name UI controls descriptively
- Optional: register metrics, expose custom data via
SetMeta("mcp_data", ...)
Connect Claude Code
{
"mcpServers": {
"godot-playtester": {
"command": "npx",
"args": ["-y", "@anthropic-ai/mcp-adapter-http", "http://localhost:9876"]
}
}
}
Tools Overview
State & Structure
get_game_state get_ui_layout get_scene_tree get_node_properties get_game_info
UI Control
click_element type_text select_option get_focused_element drag double_click hover
Input Control
press_key click_mouse move_mouse scroll_mouse simulate_input
Macro System (scripted input sequences)
execute_macro get_macro_status cancel_macro list_macros
Supports: hold_key, tap_key, repeat_key, combo_keys, move_distance, move_to (8dir/4dir/free), click, drag, double_click, type_text, wait
Visual & Metrics
screenshot register_metric get_metrics
Test Runner
start_test get_test_results
Log System (three-tier)
get_logs get_debug_logs log get_file_logs get_file_log_summary clear_logs
Node Manipulation
set_node_property call_node_method
Documentation
| Document | Content |
|---|---|
| Deploy Guide | Step-by-step installation and configuration |
| Integration Guide | Game code conventions (Groups, UI names, logging) |
| Testing Guide | Three-phase playtest process (Prep โ Execute โ Report) |
| Debugging Guide | Common pitfalls, root causes, and fixes |
| Requirements | Dependencies and recommended tools |
Project Structure
โโโ README.md โ You are here
โโโ src/ โ C# source files (copy these to your Godot project)
โ โโโ GameMcpServer.cs Core: lifecycle, public API
โ โโโ GameMcpServer.Http.cs HTTP server, JSON-RPC protocol
โ โโโ GameMcpServer.Helpers.cs Shared utilities
โ โโโ GameMcpServer.Result.cs JSON response builders
โ โโโ GameMcpServer.Tools.cs Tool registration dispatcher
โ โโโ GameMcpServer.Tools.Scene.cs Scene tree & node tools
โ โโโ GameMcpServer.Tools.Query.cs Game state & UI query tools
โ โโโ GameMcpServer.Tools.UI.cs UI interaction tools
โ โโโ GameMcpServer.Tools.Input.cs Input simulation tools
โ โโโ GameMcpServer.Tools.Diagnostics.cs Metrics, testing, logging
โ โโโ GameMcpServer.MacroTypes.cs Macro data types
โ โโโ GameMcpServer.Macro.cs Macro execution engine
โ โโโ GameMcpServer.MacroTools.cs Macro MCP tools
โ โโโ RingBuffer.cs Ring buffer utility
โโโ docs/ โ Documentation
โ โโโ deploy.md
โ โโโ integration.md
โ โโโ testing.md
โ โโโ debugging.md
โ โโโ requirements.md
โโโ skill.md โ Claude Code skill definition
Requirements
- Godot 4.6+ with .NET/C# support
- Recommended: godot-mcp (editor-side MCP for creating scenes, running project)
