GITHUB_README.mdโข3.07 kB
# ๐ค Godot Sentinel MCP
**Terminal-based AI assistant for Godot development via Model Context Protocol (MCP)**
[](https://opensource.org/licenses/MIT)
[](https://nodejs.org/)
[](https://godotengine.org/)
Sentinel bridges AI assistants (Claude, ChatGPT, etc.) with your Godot projects, enabling automatic error detection, context gathering, and intelligent code fixesโall from your terminal.
## โจ Features
- ๐ **Automatic Error Detection** - Monitors Godot tests and runtime for errors
- ๐ง **AI-Powered Fixes** - Generates and applies precise code patches
- ๐ก๏ธ **Safe Patching** - Creates git branches for every change
- ๐ฎ **Game Engine Aware** - Understands Godot 4 patterns and constraints
- ๐ง **Terminal First** - No IDE required, pure command-line workflow
- ๐ **MCP Compatible** - Works with any MCP-enabled AI assistant
## ๐ Quick Start
```bash
# Install and setup
npm install -g godot-sentinel-mcp
cd your-godot-project
sentinel init
# Start the MCP server
sentinel server
# In another terminal, use with Claude Code or other MCP client
claude-code # Now has access to your Godot project!
```
## ๐น Demo
```bash
$ sentinel test
๐งช Running tests...
โ Tests failed
๐จ Error: Invalid call 'get_damage' in fighter.gd:45
$ # Ask your AI assistant: "What's wrong with my game?"
# AI can now see the error, read your code, and suggest fixes!
```
## ๐ ๏ธ How It Works
1. **Monitor** - Watches your Godot project for test failures and runtime errors
2. **Parse** - Extracts structured error information from Godot logs
3. **Expose** - Provides MCP tools for AI assistants to access your project
4. **Fix** - AI can read context, propose changes, and apply patches safely
5. **Verify** - Re-runs tests to ensure fixes work
## ๐ฏ Perfect For
- **Godot developers** who want AI-powered debugging
- **Terminal enthusiasts** who prefer command-line workflows
- **Teams** wanting automated error detection and fixing
- **Streamers/content creators** doing live Godot development
## ๐ Documentation
- [Installation Guide](docs/installation.md)
- [MCP Integration](docs/mcp-setup.md)
- [Godot Project Setup](docs/godot-setup.md)
- [API Reference](docs/api.md)
- [Troubleshooting](docs/troubleshooting.md)
## ๐ค Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
### Roadmap
- [ ] Support for Godot 3.x
- [ ] Integration with more MCP clients
- [ ] Visual Studio Code extension
- [ ] CI/CD pipeline integration
- [ ] Performance profiling tools
## ๐ License
MIT License - see [LICENSE](LICENSE) for details.
## ๐ Acknowledgments
- [Anthropic](https://anthropic.com) for the MCP protocol
- [Godot Engine](https://godotengine.org) community
- [gdUnit4](https://github.com/MikeSchulze/gdUnit4) testing framework
---
**โญ Star this repo if it helps your Godot development!**