Skip to content

Commit ba8b513

Browse files
committed
docs: improve readme clarity and focus on core features
- Reorganize content to better highlight compilation resilience and AI-focused design - Remove redundant "what we don't include" section by integrating rationale into feature descriptions - Add more specific examples of how compilation handling works - Clarify test execution capabilities with log access details
1 parent 328e7cb commit ba8b513

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,20 @@
44
55
## 🎯 Why Unity Code MCP?
66

7-
**The Problem**: Existing Unity MCP servers fail when Unity is compiling or performing domain reloads, causing AI tool calls to break and interrupting development workflows. Additionally, they often include broad Unity operations (scene editing, package management, asset manipulation) that distract from the core task of code development.
7+
Unity Code MCP is laser-focused on what AI agents do best - **writing code**. It's specifically designed to handle Unity's compilation cycles gracefully while providing only the essential tools needed for autonomous code development: compilation feedback and test execution.
88

9-
**The Solution**: Unity Code MCP is laser-focused on what AI agents do best - **writing code**. It's specifically designed to handle Unity's compilation cycles gracefully while providing only the essential tools needed for autonomous code development: compilation feedback and test execution.
9+
Other Unity MCP servers typically fail when Unity is compiling or performing domain reloads, causing AI tool calls to report an error and AI agents confused about what is going on.
1010

11-
**🎯 Coding-First Philosophy**: Unlike other Unity MCP servers, we deliberately exclude scene editing, package management, and asset manipulation. This focused approach maximizes AI productivity by concentrating on code development workflows where AI agents excel.
11+
Example, with a typical Unity MCP server, when Unity Editor is compiling, and AI make a tool call to run tests. The tool fails because of disconnection.
12+
13+
Not Unity Code MCP! AI agent can make a tool call, whether to refresh asset database or run tests, while Unity is compiling. And the tool call with wait for the compilation to finish and then refresh asset database or run tests.
14+
15+
**🎯 Coding-First Philosophy**: Unlike other Unity MCP servers, we deliberately exclude scene editing, package management, and asset manipulation. This focused approach allow us to ensure high quality and high performance implementation because there is less code to maintain. This also reduces your token usage because AI has less instructions to read about the tools.
1216

1317
## ✨ Key Features
1418

1519
- **🔄 Compilation-Resilient**: Survives Unity domain reloads and compilation cycles
16-
- **🤖 AI-Optimized**: Streamlined tools designed for efficient AI agent workflows
20+
- **🤖 AI-Optimized**: Streamlined tools designed for efficient AI agent coding workflows
1721
- **⚡ Performance-Focused**: Minimal token usage with targeted, essential operations
1822
- **🧪 Test-Driven**: Comprehensive test execution and reporting capabilities
1923
- **📦 Self-Contained**: Single binary with no runtime dependencies (no Node.js, Python, or .NET required)
@@ -32,27 +36,21 @@ Unity Code MCP provides **exactly two tools** designed for autonomous code devel
3236
### 2. **Test Execution**
3337
- Runs Unity tests with comprehensive reporting
3438
- Provides stack traces for failures
39+
- Provides logs for logs captured in a test (this will help AI agents to debug the test by inserting `Debug.Log` statements)
3540
- Supports both EditMode and PlayMode tests
3641

37-
### 🚫 What We Don't Include (By Design)
38-
39-
Unlike other Unity MCP servers, we intentionally **exclude**:
40-
- Scene editing and manipulation
41-
- Package management operations
42-
- Asset creation and modification
43-
- GameObject hierarchy management
44-
- Inspector property editing
45-
4642
### Why Only Two Tools?
4743

4844
This laser-focused approach maximizes AI efficiency by:
4945
- **Eliminating token waste** on non-coding operations
50-
- **Concentrating on AI strengths** - code generation and debugging
46+
- **Concentrating on AI strengths** - writing code
5147
- **Providing only essential feedback** for the code development loop
5248
- **Reducing complexity** and potential failure points
5349

5450
Result: AI agents maintain a highly productive development loop: *write → compile → fix errors → test → fix bugs → repeat*.
5551

52+
AI agents can't read other logs, only current compilation errors from Asset Database Refresh tool call, this means less waste of tool calls and less token usage, give AI only what is useful.
53+
5654
## 🚀 Quick Start Example
5755

5856
Once configured, AI assistants can interact with Unity like this:

0 commit comments

Comments
 (0)