Skip to content

Commit 7425bc3

Browse files
committed
Fix wording
1 parent 0704409 commit 7425bc3

1 file changed

Lines changed: 16 additions & 15 deletions

File tree

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ Adds tools for operating Unity Editor from any Coding Agents.
2828
The `run_unity_tests` tool runs tests on Unity Editor through Rider's test infrastructure.
2929
Recommend filtering by `assemblyNames`, `categoryNames`, `groupNames`, and `testNames` to narrow down the tests to the scope of changes.
3030

31+
> [!TIP]\
32+
> You can also run Play Mode tests with domain reloading.
33+
3134
**Parameters**
3235

3336
| Name | Required | Description |
@@ -50,26 +53,24 @@ Recommend filtering by `assemblyNames`, `categoryNames`, `groupNames`, and `test
5053
| `failedTests` | array | Details of failed tests (`testId`, `output`, `duration`) |
5154
| `inconclusiveTests` | array | Details of inconclusive tests (`testId`, `output`, `duration`) |
5255

56+
> [!NOTE]\
57+
> To save space in the context window, outputs of successful and skipped tests are not included in the response.
58+
5359
**Error Response**
5460

5561
| Field | Type | Description |
5662
|----------------|---------|----------------|
5763
| `success` | boolean | Always `false` |
5864
| `errorMessage` | string | Error details |
5965

60-
> [!TIP]\
61-
> You can also run Play Mode tests that involve the domain reloading.
62-
63-
> [!TIP]\
64-
> To save space in the context window, outputs of successful and skipped tests are not included in the response.
65-
6666
### Run editor script
6767

68-
The `run_method_in_unity` tool invokes a static method in Unity Editor via reflection.
69-
You can use this tool to edit scenes and prefabs.
70-
68+
The `run_method_in_unity` tool invokes a static method on Unity Editor via reflection.
7169
Console logs during the method will be captured and returned in the `logs` field of the response.
7270

71+
> [!TIP]\
72+
> You can use this tool to edit scene and prefab files.
73+
7374
**Parameters**
7475

7576
| Name | Required | Description |
@@ -87,19 +88,19 @@ The method must be **static and parameterless**.
8788
| `success` | boolean | Always `true` (indicates reflection succeeded; does not mean the method executed without errors — internal exceptions are captured in `logs`) |
8889
| `logs` | array | Console log entries captured during execution (may be empty). Each entry has `type` (`"Message"`, `"Warning"`, `"Error"`), `message`, and `stackTrace`. |
8990

91+
> [!IMPORTANT]\
92+
> The method's return value is **NOT** returned. `success` only indicates whether the method was found and invoked (reflection succeeded). Even if the method throws internally, `success` may be `true` — the exception is captured in the `logs` field.
93+
94+
> [!IMPORTANT]\
95+
> Async methods can be invoked, but the tool does not await their completion. Logs generated after return to the caller will not be included in the response.
96+
9097
**Error Response**
9198

9299
| Field | Type | Description |
93100
|----------------|---------|----------------|
94101
| `success` | boolean | Always `false` |
95102
| `errorMessage` | string | Error details |
96103

97-
> [!IMPORTANT]\
98-
> The method's return value is **NOT** returned. `success` only indicates whether the method was found and invoked (reflection succeeded). Even if the method throws internally, `success` may be `true` — the exception is captured in the `logs` field.
99-
100-
> [!IMPORTANT]\
101-
> Async methods can be invoked, but the tool does not await their completion. Logs generated after the method returns to the caller will not be included in the response.
102-
103104
### Check compilation
104105

105106
The `get_unity_compilation_result` tool triggers Unity's `AssetDatabase.Refresh()` and checks if compilation succeeded.

0 commit comments

Comments
 (0)