Skip to content

Commit ac51e57

Browse files
committed
docs: fix typos and clarify README descriptions
Correct grammatical errors and improve clarity in README.md. Specifically: - Fix "with wait" to "will wait" in tool call description - Add explanation about nested compilation behavior - Clarify that asset refresh only returns errors, not warnings or info logs
1 parent ba8b513 commit ac51e57

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Other Unity MCP servers typically fail when Unity is compiling or performing dom
1010

1111
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.
1212

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.
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 will wait for the compilation to finish and then proceed to refresh asset database or run tests. Yes, AI can tell Unity to compile while Unity is compiling! In fact AI can modify code while Unity is compiling and then tell Unity to compile while Unity is still compiling and the tool call will still succeed because it will wait for the compilation to finish and trigger a new compilation(only if needed).
1414

1515
**🎯 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.
1616

@@ -29,7 +29,7 @@ Unity Code MCP provides **exactly two tools** designed for autonomous code devel
2929

3030
### 1. **Asset Database Refresh**
3131
- Triggers Unity compilation and asset processing
32-
- Returns only compilation errors and nothing else
32+
- Returns only compilation errors and other errors during the refresh, no warnings or info logs.
3333
- Handles domain reload scenarios gracefully
3434
- Essential for validating code correctness
3535

0 commit comments

Comments
 (0)