Merge pull request #157 from IvanMurzak/dev

feat: Add TestRunner MCP tool and support for MCP client timeout configuration

Author: IvanMurzak

.github/workflows/2022.3.61f1_editmode.yml

@@ -2,13 +2,11 @@ name: 2022.3.61f1-editmode
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/2022.3.61f1_playmode.yml

@@ -2,13 +2,11 @@ name: 2022.3.61f1-playmode
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/2022.3.61f1_standalone.yml

@@ -2,13 +2,11 @@ name: 2022.3.61f1-standalone
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/2023.2.20f1_editmode.yml

@@ -2,13 +2,11 @@ name: 2023.2.20f1-editmode
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/2023.2.20f1_playmode.yml

@@ -2,13 +2,11 @@ name: 2023.2.20f1-playmode
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/2023.2.20f1_standalone.yml

@@ -2,13 +2,11 @@ name: 2023.2.20f1-standalone
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/6000.0.46f1_editmode.yml

@@ -2,13 +2,11 @@ name: 6000.0.46f1-editmode
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/6000.0.46f1_playmode.yml

@@ -2,13 +2,11 @@ name: 6000.0.46f1-playmode
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

.github/workflows/6000.0.46f1_standalone.yml

@@ -2,13 +2,11 @@ name: 6000.0.46f1-standalone
 
 on:
   pull_request:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   pull_request_target:
-    branches:
-      - main
+    branches: [main, dev]
     types: [opened, synchronize, reopened]
 
   push:

Assets/root/Documentation~/README.md

@@ -1,14 +1,14 @@
-# Unity MCP (Server + Plugin)
+# Unity MCP (AI Connector)
 
 [![openupm](https://img.shields.io/npm/v/com.ivanmurzak.unity.mcp?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.ivanmurzak.unity.mcp/) ![License](https://img.shields.io/github/license/IvanMurzak/Unity-MCP) [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)
 
 ![image](https://github.com/user-attachments/assets/8f595879-a578-421a-a06d-8c194af874f7)
 
 | Unity Version | Editmode | Playmode | Standalone |
 |---------------|----------|----------|------------|
-| 2022.3.61f1   | ![2022.3.61f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2022.3.61f1_editmode.yml?label=2022.3.61f1-editmode) | ![2022.3.61f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2022.3.61f1_playmode.yml?label=2022.3.61f1-playmode) | ![2022.3.61f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2022.3.61f1_standalone.yml?label=2022.3.61f1-standalone) |
-| 2023.2.20f1   | ![2023.2.20f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2023.2.20f1_editmode.yml?label=2023.2.20f1-editmode) | ![2023.2.20f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2023.2.20f1_playmode.yml?label=2023.2.20f1-playmode) | ![2023.2.20f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2023.2.20f1_standalone.yml?label=2023.2.20f1-standalone) |
-| 6000.0.46f1   | ![6000.0.46f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/6000.0.46f1_editmode.yml?label=6000.0.46f1-editmode) | ![6000.0.46f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/6000.0.46f1_playmode.yml?label=6000.0.46f1-playmode) | ![6000.0.46f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/6000.0.46f1_standalone.yml?label=6000.0.46f1-standalone) |
+| 2022.3.61f1   | ![2022.3.61f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2022.3.61f1_editmode.yml?label=2022.3.61f1-editmode&branch=main) | ![2022.3.61f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2022.3.61f1_playmode.yml?label=2022.3.61f1-playmode&branch=main) | ![2022.3.61f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2022.3.61f1_standalone.yml?label=2022.3.61f1-standalone&branch=main) |
+| 2023.2.20f1   | ![2023.2.20f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2023.2.20f1_editmode.yml?label=2023.2.20f1-editmode&branch=main) | ![2023.2.20f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2023.2.20f1_playmode.yml?label=2023.2.20f1-playmode&branch=main) | ![2023.2.20f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/2023.2.20f1_standalone.yml?label=2023.2.20f1-standalone&branch=main) |
+| 6000.0.46f1   | ![6000.0.46f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/6000.0.46f1_editmode.yml?label=6000.0.46f1-editmode&branch=main) | ![6000.0.46f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/6000.0.46f1_playmode.yml?label=6000.0.46f1-playmode&branch=main) | ![6000.0.46f1](https://img.shields.io/github/actions/workflow/status/IvanMurzak/Unity-MCP/6000.0.46f1_standalone.yml?label=6000.0.46f1-standalone&branch=main) |
 
 **[Unity-MCP](https://github.com/IvanMurzak/Unity-MCP)** is a bridge between LLM and Unity. It exposes and explains to LLM Unity's tools. LLM understands the interface and utilizes the tools in the way a user asks.
 
@@ -20,6 +20,13 @@ The system is extensible: you can define custom `tool`s directly in your Unity p
 
 ## AI Tools
 
+Unity-MCP supports a wide range of tools. Each tool is a small connector between LLM and Unity Engine. You may create your own `tools` by using API, take a look at [add custom tool](#add-custom-tool).
+
+Here is the list of default AI tools. All of them are available after installation Unity-MCP into your project.
+
+> **Legend:**
+> ✅ = Implemented & available, 🔲 = Planned / Not yet implemented
+
 <table>
 <tr>
 <td valign="top">
@@ -59,7 +66,7 @@ The system is extensible: you can define custom `tool`s directly in your Unity p
   - ✅ Add
   - ✅ Remove
 - ✅ Execute `MenuItem`
-- 🔲 Run Tests
+- ✅ Run Tests (see note in [running play mode tests](#running-playmode-tests))
 
 #### Editor.Selection
 
@@ -144,9 +151,6 @@ The system is extensible: you can define custom `tool`s directly in your Unity p
 </tr>
 </table>
 
-> **Legend:**
-> ✅ = Implemented & available, 🔲 = Planned / Not yet implemented
-
 # Installation
 
 1. [Install .NET 9.0](https://dotnet.microsoft.com/en-us/download)
@@ -233,11 +237,16 @@ public class Tool_GameObject
 
 > ⚠️ Not yet supported. The work is in progress
 
+# Running PlayMode tests
+
+To be able to run Play Mode tests via the TestRunner MCP tool, you should consider configuring Unity to **not** perform a domain reload when entering Play Mode (`Edit -> Project Settings -> Editor -> Enter Play Mode Settings` - set to `Reload Scene only` or `Do not reload Domain or Scene`). Otherwise, starting the Play Mode tests will interrupt the TestRunner MCP tool, leading to a cycle of tests restarting.
+
 
 # Contribution
 
-Feel free to add new `tool` into the project.
+Feel free to add a new `tool` into the project.
 
 1. Fork the project.
-2. Implement new `tool` in your forked repository.
-3. Create Pull Request into original [Unity-MCP](https://github.com/IvanMurzak/Unity-MCP) repository.
+2. Clone the fork and open the resulting folder in Unity.
+3. Implement the new `tool` in your forked repository.
+4. Create Pull Request into original [Unity-MCP](https://github.com/IvanMurzak/Unity-MCP) repository.