vqt123/unity-mcp-server
If you are the rightful owner of unity-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
The Unity MCP Server is a bridge that enables AI assistants to control the Unity Editor through natural language.
Unity MCP Server Documentation
Welcome! This folder contains complete documentation for building a Unity MCP (Model Context Protocol) Server.
📚 Quick Navigation
🆕 First Time Here?
→ Start with
This gives you an overview, installation instructions, and quick start guide.
📋 Looking for Something Specific?
→ Check
Complete navigation guide to find exactly what you need.
⚡ Need Quick Reference?
→ See
One-page cheat sheet with common commands and troubleshooting.
📖 All Documents
| # | Document | Purpose | Read Time |
|---|---|---|---|
| 0 | Overview of all docs | 5 min | |
| 1 | Navigation hub | 10 min | |
| 2 | Main entry point | 15 min | |
| 3 | Complete design | 45 min | |
| 4 | Code & implementation | 60 min | |
| 5 | API reference (46 tools) | 30 min | |
| 6 | One-page guide | 10 min |
🎯 Choose Your Path
I want to USE Unity MCP
1. Read Unity-MCP-README.md
2. Follow Quick Start section
3. Bookmark Unity-MCP-Quick-Reference.md
4. Start using with AI!
I want to BUILD Unity MCP
1. Read Unity-MCP-README.md (overview)
2. Study Unity-MCP-Server-Design.md (architecture)
3. Follow Unity-MCP-Implementation-Guide.md (code)
4. Reference Unity-MCP-Tool-Catalog.md (API)
5. Start implementing!
I want to CONTRIBUTE
1. Read Unity-MCP-README.md (overview)
2. Study Unity-MCP-Server-Design.md (architecture)
3. Review Unity-MCP-Tool-Catalog.md (existing tools)
4. Design your new tool
5. Submit PR!
I need HELP
1. Check Unity-MCP-Quick-Reference.md (troubleshooting)
2. Search Unity-MCP-Index.md (find specific topic)
3. Read relevant section in detail
4. Still stuck? Check support resources
🚀 What is Unity MCP Server?
A bridge that enables AI assistants (like Claude) to control Unity Editor through natural language:
You: "Create a red cube with physics"
↓
AI: Executes MCP tool
↓
Unity: Cube created!
Key Features
- 46 Tools covering all major Unity operations
- Natural Language control through AI
- Safe & Secure with multiple protection layers
- Fast (< 100ms for reads, < 500ms for writes)
- Comprehensive documentation
📊 Documentation Stats
- Total Documents: 7 files
- Total Lines: ~5,500 lines
- Total Words: ~30,000 words
- Code Examples: 20+ complete examples
- Tools Documented: 46 tools
- Diagrams: 5 ASCII diagrams
🎓 Learning Paths
Fast Path (1 hour)
- Unity-MCP-README.md → Quick Reference → Start using
Developer Path (4-8 hours)
- README → Design Doc → Implementation Guide → Tool Catalog → Build
Reference Path (as needed)
- Tool Catalog for specific tools
- Quick Reference for common tasks
- Index for finding anything
📞 Need Help?
- Lost? →
- Quick Question? →
- Deep Dive? →
- Code? →
- API? →
📅 Version Information
Version: 1.0 (Planning Phase)
Created: October 10, 2025
Status: ✅ Complete
Next Step: Begin Phase 1 implementation