godot_mcp AGENTS.md

AGENTS.md - Godot MCP Project Guidelines

Shell Preference

• Prefer bash for command execution and automated workflows.

• Ask the user for permission before using PowerShell, including Windows PowerShell and PowerShell 7.

• If PowerShell use is approved, PowerShell 7.6.1 is preferred when available:

  • Install path: C:\Program Files\WindowsApps\Microsoft.PowerShell_7.6.1.0_x64__8wekyb3d8bbwe\pwsh.exe
  • Before using, verify the path exists.
  • If it exists, use it.
  • If not found, fall back to the system PowerShell only after user permission.

Code Language Policy

• No non-English prose allowed in any code files
• All text in code files must be in English
• Multilingual text artifacts are not supported in this repo

Build & Run Commands

• Run Godot Project: Open project.godot in the Godot Editor.

Code Style Guidelines

GDScript (Godot)

• Use snake_case for variables, methods, and function names
• Use PascalCase for classes
• Use type hints where possible: var player: Player
• Follow Godot singleton conventions (e.g., Engine, OS)
• Prefer signals for communication between nodes

General

• Use descriptive names
• Keep functions small and focused
• Add comments for complex logic
• Error handling: use assertions in GDScript

Testing Policy (Required)

Every code change must update or create corresponding tests under test/:

• Direct tests: cover the logic changed in this update, including normal paths, boundary conditions, and error handling.
• Impact-scope tests: identify and test related modules that may be affected by this change. If public method signatures, exported variables, signals, strategy classes, or similar shared interfaces change, cover all callers.
• Add corresponding tests when possible
• If the baseline test suite already contains failures, do not introduce new failures and document any pre-existing failures relevant to the change.

New Tool Workflow

New Tool Checklist