{"_id":"@coding-solo/godot-mcp","name":"@coding-solo/godot-mcp","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.1":{"name":"@coding-solo/godot-mcp","version":"0.1.1","description":"MCP server for interfacing with Godot game engine. Provides tools for launching the editor, running projects, and capturing debug output.","keywords":["godot","mcp","ai","claude","cline"],"homepage":"https://github.com/Coding-Solo/godot-mcp","bugs":{"url":"https://github.com/Coding-Solo/godot-mcp/issues"},"repository":{"type":"git","url":"git+https://github.com/Coding-Solo/godot-mcp.git"},"license":"MIT","author":{"name":"Solomon Elias","email":"solomon@sippy.ai"},"type":"module","bin":{"godot-mcp":"build/index.js"},"scripts":{"build":"tsc && node scripts/build.js","inspector":"npx @modelcontextprotocol/inspector build/index.js","prepare":"npm run build","watch":"tsc --watch"},"dependencies":{"@modelcontextprotocol/sdk":"0.6.0","axios":"^1.7.9","fs-extra":"^11.2.0"},"devDependencies":{"@types/node":"^20.11.24","typescript":"^5.3.3"},"engines":{"node":">=18.0.0"},"_id":"@coding-solo/godot-mcp@0.1.1","gitHead":"f341234dfe44613e1d48fe4fbc8bfb9bf2e8e9eb","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-tSwmKN5D3JWGfnyPFxijxjdsT+GKIQrf9g6zYNefLvOVYx2UTC9PhyFFHc9vphtjyFrtjYf1n5Vq1zRNN3UXBA==","shasum":"1a52ba94095fef4ebb51916503989f8dcb3cfc94","tarball":"https://registry.npmjs.org/@coding-solo/godot-mcp/-/godot-mcp-0.1.1.tgz","fileCount":5,"unpackedSize":140324,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDRQAYWsRCrhm5W3FIeEnFBdwzEptXJmCbrp/xJ7T+snAIgLMj3Dl5nDc8rAwSoNJIA4fHQVye0fY6vHVrPHk593tI="}]},"_npmUser":{"name":"coding-solo","email":"solomon@sippy.ai"},"directories":{},"maintainers":[{"name":"coding-solo","email":"solomon@sippy.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/godot-mcp_0.1.1_1770139407071_0.7387741642620549"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-03T17:23:27.007Z","0.1.1":"2026-02-03T17:23:27.236Z","modified":"2026-02-03T17:23:27.410Z"},"maintainers":[{"name":"coding-solo","email":"solomon@sippy.ai"}],"description":"MCP server for interfacing with Godot game engine. Provides tools for launching the editor, running projects, and capturing debug output.","homepage":"https://github.com/Coding-Solo/godot-mcp","keywords":["godot","mcp","ai","claude","cline"],"repository":{"type":"git","url":"git+https://github.com/Coding-Solo/godot-mcp.git"},"author":{"name":"Solomon Elias","email":"solomon@sippy.ai"},"bugs":{"url":"https://github.com/Coding-Solo/godot-mcp/issues"},"license":"MIT","readme":"\n# Godot MCP\n\n[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/Coding-Solo)\n\n[![](https://badge.mcpx.dev?type=server 'MCP Server')](https://modelcontextprotocol.io/introduction)\n[![Made with Godot](https://img.shields.io/badge/Made%20with-Godot-478CBF?style=flat&logo=godot%20engine&logoColor=white)](https://godotengine.org)\n[![](https://img.shields.io/badge/Node.js-339933?style=flat&logo=nodedotjs&logoColor=white 'Node.js')](https://nodejs.org/en/download/)\n[![](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white 'TypeScript')](https://www.typescriptlang.org/)\n\n[![](https://img.shields.io/github/last-commit/Coding-Solo/godot-mcp 'Last Commit')](https://github.com/Coding-Solo/godot-mcp/commits/main)\n[![](https://img.shields.io/github/stars/Coding-Solo/godot-mcp 'Stars')](https://github.com/Coding-Solo/godot-mcp/stargazers)\n[![](https://img.shields.io/github/forks/Coding-Solo/godot-mcp 'Forks')](https://github.com/Coding-Solo/godot-mcp/network/members)\n[![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)\n\n```text\n                           (((((((             (((((((                          \n                        (((((((((((           (((((((((((                      \n                        (((((((((((((       (((((((((((((                       \n                        (((((((((((((((((((((((((((((((((                       \n                        (((((((((((((((((((((((((((((((((                       \n         (((((      (((((((((((((((((((((((((((((((((((((((((      (((((        \n       (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((      \n     ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((    \n    ((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((    \n      (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((     \n        (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((       \n         (((((((((((@@@@@@@(((((((((((((((((((((((((((@@@@@@@(((((((((((        \n         (((((((((@@@@,,,,,@@@(((((((((((((((((((((@@@,,,,,@@@@(((((((((        \n         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((        \n         ((((((((@@@,,,,,,,,,@@(((((((@@@@@(((((((@@,,,,,,,,,@@@((((((((        \n         (((((((((@@@,,,,,,,@@((((((((@@@@@((((((((@@,,,,,,,@@@(((((((((        \n         ((((((((((((@@@@@@(((((((((((@@@@@(((((((((((@@@@@@((((((((((((        \n         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((        \n         (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((        \n         @@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@((((((((((((@@@@@@@@@@@@@        \n         ((((((((( @@@(((((((((((@@(((((((((((@@(((((((((((@@@ (((((((((        \n         (((((((((( @@((((((((((@@@(((((((((((@@@((((((((((@@ ((((((((((        \n          (((((((((((@@@@@@@@@@@@@@(((((((((((@@@@@@@@@@@@@@(((((((((((         \n           (((((((((((((((((((((((((((((((((((((((((((((((((((((((((((          \n              (((((((((((((((((((((((((((((((((((((((((((((((((((((             \n                 (((((((((((((((((((((((((((((((((((((((((((((((                \n                        (((((((((((((((((((((((((((((((((                       \n                                                                                \n\n                          /$$      /$$  /$$$$$$  /$$$$$$$ \n                         | $$$    /$$$ /$$__  $$| $$__  $$\n                         | $$$$  /$$$$| $$  \\__/| $$  \\ $$\n                         | $$ $$/$$ $$| $$      | $$$$$$$/\n                         | $$  $$$| $$| $$      | $$____/ \n                         | $$\\  $ | $$| $$    $$| $$      \n                         | $$ \\/  | $$|  $$$$$$/| $$      \n                         |__/     |__/ \\______/ |__/       \n```\n\nA Model Context Protocol (MCP) server for interacting with the Godot game engine.\n\n## Introduction\n\nGodot MCP enables AI assistants to launch the Godot editor, run projects, capture debug output, and control project execution - all through a standardized interface.\n\nThis direct feedback loop helps AI assistants like Claude understand what works and what doesn't in real Godot projects, leading to better code generation and debugging assistance.\n\n## Features\n\n- **Launch Godot Editor**: Open the Godot editor for a specific project\n- **Run Godot Projects**: Execute Godot projects in debug mode\n- **Capture Debug Output**: Retrieve console output and error messages\n- **Control Execution**: Start and stop Godot projects programmatically\n- **Get Godot Version**: Retrieve the installed Godot version\n- **List Godot Projects**: Find Godot projects in a specified directory\n- **Project Analysis**: Get detailed information about project structure\n- **Scene Management**:\n  - Create new scenes with specified root node types\n  - Add nodes to existing scenes with customizable properties\n  - Load sprites and textures into Sprite2D nodes\n  - Export 3D scenes as MeshLibrary resources for GridMap\n  - Save scenes with options for creating variants\n- **UID Management** (for Godot 4.4+):\n  - Get UID for specific files\n  - Update UID references by resaving resources\n\n## Requirements\n\n- [Godot Engine](https://godotengine.org/download) installed on your system\n- Node.js and npm\n- An AI assistant that supports MCP (Cline, Cursor, etc.)\n\n## Installation and Configuration\n\n### Step 1: Install and Build\n\nFirst, clone the repository and build the MCP server:\n\n```bash\ngit clone https://github.com/Coding-Solo/godot-mcp.git\ncd godot-mcp\nnpm install\nnpm run build\n```\n\n### Step 2: Configure with Your AI Assistant\n\n#### Option A: Configure with Cline\n\nAdd to your Cline MCP settings file (`~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`):\n\n```json\n{\n  \"mcpServers\": {\n    \"godot\": {\n      \"command\": \"node\",\n      \"args\": [\"/absolute/path/to/godot-mcp/build/index.js\"],\n      \"env\": {\n        \"DEBUG\": \"true\"                  // Optional: Enable detailed logging\n      },\n      \"disabled\": false,\n      \"autoApprove\": [\n        \"launch_editor\",\n        \"run_project\",\n        \"get_debug_output\",\n        \"stop_project\",\n        \"get_godot_version\",\n        \"list_projects\",\n        \"get_project_info\",\n        \"create_scene\",\n        \"add_node\",\n        \"load_sprite\",\n        \"export_mesh_library\",\n        \"save_scene\",\n        \"get_uid\",\n        \"update_project_uids\"\n      ]\n    }\n  }\n}\n```\n\n#### Option B: Configure with Cursor\n\n**Using the Cursor UI:**\n\n1. Go to **Cursor Settings** > **Features** > **MCP**\n2. Click on the **+ Add New MCP Server** button\n3. Fill out the form:\n   - Name: `godot` (or any name you prefer)\n   - Type: `command`\n   - Command: `node /absolute/path/to/godot-mcp/build/index.js`\n4. Click \"Add\"\n5. You may need to press the refresh button in the top right corner of the MCP server card to populate the tool list\n\n**Using Project-Specific Configuration:**\n\nCreate a file at `.cursor/mcp.json` in your project directory with the following content:\n\n```json\n{\n  \"mcpServers\": {\n    \"godot\": {\n      \"command\": \"node\",\n      \"args\": [\"/absolute/path/to/godot-mcp/build/index.js\"],\n      \"env\": {\n        \"DEBUG\": \"true\"                  // Enable detailed logging\n      }\n    }\n  }\n}\n```\n\n### Step 3: Optional Environment Variables\n\nYou can customize the server behavior with these environment variables:\n\n- `GODOT_PATH`: Path to the Godot executable (overrides automatic detection)\n- `DEBUG`: Set to \"true\" to enable detailed server-side debug logging\n\n## Example Prompts\n\nOnce configured, your AI assistant will automatically run the MCP server when needed. You can use prompts like:\n\n```text\n\"Launch the Godot editor for my project at /path/to/project\"\n\n\"Run my Godot project and show me any errors\"\n\n\"Get information about my Godot project structure\"\n\n\"Analyze my Godot project structure and suggest improvements\"\n\n\"Help me debug this error in my Godot project: [paste error]\"\n\n\"Write a GDScript for a character controller with double jump and wall sliding\"\n\n\"Create a new scene with a Player node in my Godot project\"\n\n\"Add a Sprite2D node to my player scene and load the character texture\"\n\n\"Export my 3D models as a MeshLibrary for use with GridMap\"\n\n\"Create a UI scene with buttons and labels for my game's main menu\"\n\n\"Get the UID for a specific script file in my Godot 4.4 project\"\n\n\"Update UID references in my Godot project after upgrading to 4.4\"\n```\n\n## Implementation Details\n\n### Architecture\n\nThe Godot MCP server uses a bundled GDScript approach for complex operations:\n\n1. **Direct Commands**: Simple operations like launching the editor or getting project info use Godot's built-in CLI commands directly.\n2. **Bundled Operations Script**: Complex operations like creating scenes or adding nodes use a single, comprehensive GDScript file (`godot_operations.gd`) that handles all operations.\n\nThis architecture provides several benefits:\n\n- **No Temporary Files**: Eliminates the need for temporary script files, keeping your system clean\n- **Simplified Codebase**: Centralizes all Godot operations in one (somewhat) organized file\n- **Better Maintainability**: Makes it easier to add new operations or modify existing ones\n- **Improved Error Handling**: Provides consistent error reporting across all operations\n- **Reduced Overhead**: Minimizes file I/O operations for better performance\n\nThe bundled script accepts operation type and parameters as JSON, allowing for flexible and dynamic operation execution without generating temporary files for each operation.\n\n## Troubleshooting\n\n- **Godot Not Found**: Set the GODOT_PATH environment variable to your Godot executable\n- **Connection Issues**: Ensure the server is running and restart your AI assistant\n- **Invalid Project Path**: Ensure the path points to a directory containing a project.godot file\n- **Build Issues**: Make sure all dependencies are installed by running `npm install`\n- **For Cursor Specifically**:\n-   Ensure the MCP server shows up and is enabled in Cursor settings (Settings > MCP)\n-   MCP tools can only be run using the Agent chat profile (Cursor Pro or Business subscription)\n-   Use \"Yolo Mode\" to automatically run MCP tool requests\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/coding-solo-godot-mcp-badge.png)](https://mseep.ai/app/coding-solo-godot-mcp)\n","readmeFilename":"README.md","_rev":"1-8ea8f2cc38a043892b607b4fb639c6f5"}