You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: README.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,20 @@
4
4
5
5
## 🎯 Why Unity Code MCP?
6
6
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.
8
8
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.
10
10
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.
12
16
13
17
## ✨ Key Features
14
18
15
19
-**🔄 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
17
21
-**⚡ Performance-Focused**: Minimal token usage with targeted, essential operations
18
22
-**🧪 Test-Driven**: Comprehensive test execution and reporting capabilities
19
23
-**📦 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
32
36
### 2. **Test Execution**
33
37
- Runs Unity tests with comprehensive reporting
34
38
- 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)
35
40
- Supports both EditMode and PlayMode tests
36
41
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
-
46
42
### Why Only Two Tools?
47
43
48
44
This laser-focused approach maximizes AI efficiency by:
49
45
-**Eliminating token waste** on non-coding operations
50
-
-**Concentrating on AI strengths** - code generation and debugging
46
+
-**Concentrating on AI strengths** - writing code
51
47
-**Providing only essential feedback** for the code development loop
52
48
-**Reducing complexity** and potential failure points
53
49
54
50
Result: AI agents maintain a highly productive development loop: *write → compile → fix errors → test → fix bugs → repeat*.
55
51
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
+
56
54
## 🚀 Quick Start Example
57
55
58
56
Once configured, AI assistants can interact with Unity like this:
0 commit comments