Update readme with better visually understandable instructions

Author: CoderGamester

README.md

@@ -1,21 +1,19 @@
-# MCP Unity [![](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white 'LinkedIn')](https://www.linkedin.com/in/miguel-tomas/)
-
-<a href="https://glama.ai/mcp/servers/@CoderGamester/mcp-unity">
-  <img width="380" height="200" src="https://glama.ai/mcp/servers/@CoderGamester/mcp-unity/badge" alt="Unity MCP server" />
-</a>
+# MCP Unity
 
 [![](https://badge.mcpx.dev?type=server 'MCP Server')](https://modelcontextprotocol.io/introduction)
 [![smithery badge](https://smithery.ai/badge/@CoderGamester/mcp-unity)](https://smithery.ai/server/@CoderGamester/mcp-unity)
 [![](https://img.shields.io/badge/Unity-000000?style=flat&logo=unity&logoColor=white 'Unity')](https://unity.com/releases/editor/archive)
 [![](https://img.shields.io/badge/Node.js-339933?style=flat&logo=nodedotjs&logoColor=white 'Node.js')](https://nodejs.org/en/download/)
-[![](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white 'TypeScript')](https://www.typescriptlang.org/)
-[![](https://img.shields.io/badge/WebSocket-4353FF?style=flat&logo=socket.io&logoColor=white 'WebSocket')](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API)
 
-[![](https://img.shields.io/github/last-commit/CoderGamester/mcp-unity 'Last Commit')](https://github.com/CoderGamester/mcp-unity/commits/main)
 [![](https://img.shields.io/github/stars/CoderGamester/mcp-unity 'Stars')](https://github.com/CoderGamester/mcp-unity/stargazers)
 [![](https://img.shields.io/github/forks/CoderGamester/mcp-unity 'Forks')](https://github.com/CoderGamester/mcp-unity/network/members)
+[![](https://img.shields.io/github/last-commit/CoderGamester/mcp-unity 'Last Commit')](https://github.com/CoderGamester/mcp-unity/commits/main)
 [![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
 
+<a href="https://glama.ai/mcp/servers/@CoderGamester/mcp-unity">
+  <img width="380" height="200" src="https://glama.ai/mcp/servers/@CoderGamester/mcp-unity/badge" alt="Unity MCP server" />
+</a>
+
 ```                                                                        
                               ,/(/.   *(/,                                  
                           */(((((/.   *((((((*.                             
@@ -45,6 +43,7 @@
      ██║╚██╔╝██║██║     ██╔═══╝         ██║   ██║██║╚██╗██║██║   ██║     ╚██╔╝  
      ██║ ╚═╝ ██║╚██████╗██║             ╚██████╔╝██║ ╚████║██║   ██║      ██║   
      ╚═╝     ╚═╝ ╚═════╝╚═╝              ╚═════╝ ╚═╝  ╚═══╝╚═╝   ╚═╝      ╚═╝   
+```       
 
 MCP Unity is an implementation of the Model Context Protocol for Unity Editor, allowing AI assistants to interact with your Unity projects. This package provides a bridge between Unity and a Node.js server that implements the MCP protocol, enabling AI agents like Claude, Windsurf, and Cursor to execute operations within the Unity Editor.
 
@@ -67,13 +66,15 @@ MCP Unity currently provides the following resources:
 - **get_tests**: Retrieves information about tests in the Unity Test Runner
 
 ## Requirements
-- Unity 2022.3 or later
-- Node.js 18 or later (for running the server)
-- npm 9 or later (for building the server)
+- Unity 2022.3 or later - to [install the server](#install-server)
+- Node.js 18 or later - to [start the server](#start-server)
+- npm 9 or later - to [debug the server](#debug-server)
+
+## <a name="install-server"></a>Installation
 
-## Installation
+Installing this MCP Unity Server is a multi-step process:
 
-### Installing the Unity MCP Server package via Unity Package Manager
+### Step 1: Install Unity MCP Server package via Unity Package Manager
 1. Open the Unity Package Manager (Window > Package Manager)
 2. Click the "+" button in the top-left corner
 3. Select "Add package from git URL..."
@@ -83,10 +84,12 @@ MCP Unity currently provides the following resources:
 ![package manager](https://github.com/user-attachments/assets/a72bfca4-ae52-48e7-a876-e99c701b0497)
 
 
-### Installing Node.js 
+### Step 2: Install Node.js 
 > To run MCP Unity server, you'll need to have Node.js 18 or later installed on your computer:
 
-#### Windows
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Windows</span></summary>
+
 1. Visit the [Node.js download page](https://nodejs.org/en/download/)
 2. Download the Windows Installer (.msi) for the LTS version (recommended)
 3. Run the installer and follow the installation wizard
@@ -95,8 +98,11 @@ MCP Unity currently provides the following resources:
    node --version
    npm --version
    ```
+</details>
+
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">macOS</span></summary>
 
-#### macOS
 1. Visit the [Node.js download page](https://nodejs.org/en/download/)
 2. Download the macOS Installer (.pkg) for the LTS version (recommended)
 3. Run the installer and follow the installation wizard
@@ -109,90 +115,133 @@ MCP Unity currently provides the following resources:
    node --version
    npm --version
    ```
+</details>
+
+### Step 3: Configure AI LLM Client
+
+<details open>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Option 1: Configure using Unity Editor</span></summary>
+
+> Replace `ABSOLUTE/PATH/TO` with the absolute path to your MCP Unity installation.
+
+The right configuration can be accessed in the Unity Editor MCP Server window (Tools > MCP Unity > Server Window)
+
+![MCP configuration](https://github.com/user-attachments/assets/ea9bb912-94a7-4409-81c1-3af39158dac0)
 
-### Installing via Smithery
+</details>
+
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Option 2: Configure via Smithery</span></summary>
 
 To install MCP Unity via [Smithery](https://smithery.ai/server/@CoderGamester/mcp-unity):
 
 ```
 Currently not available
 ```
+</details>
 
-## Configure MCP Server
+<details open>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Option 3: Configure Manually</span></summary>
 
-> Replace `ABSOLUTE/PATH/TO` with the absolute path to your MCP Unity installation.
+<div style="padding-left: 20px;">
 
-The right configuration can be accessed in the Unity Editor MCP Server window (Tools > MCP Unity > Server Window)
+<details>
+<summary><span style="font-size: 1em">Option 3.1: Configure Claude Desktop</span></summary>
 
-![MCP configuration](https://github.com/user-attachments/assets/ea9bb912-94a7-4409-81c1-3af39158dac0)
+<div style="padding-left: 10px;">
 
+Open the MCP configuration file (claude_desktop_config.json) in Claude Desktop Developer in (File > Settings > Developer > Edit Config)
 
-### Configure your AI client
+```json
+{
+   "mcpServers": {
+   "mcp-unity": {
+      "command": "node",
+      "args": [
+         "ABSOLUTE/PATH/TO/mcp-unity/Server/build/index.js"
+      ],
+      "env": {
+         "UNITY_PORT": "8090"
+      }
+   }
+   }
+}
+```
+</div>
 
-To configure Cursor IDE:
-- Add the following configuration to your Cursor MCP Configure settings:
+</details>
 
-```
-Name: MCP Unity
-Type: commmand
-Command: env UNITY_PORT=8090 node ABSOLUTE/PATH/TO/mcp-unity/Server/build/index.js
-```
+<details>
+<summary><span style="font-size: 1em">Option 3.2: Configure Windsurf IDE</span></summary>
 
-To configure Claude Desktop:
-- Open the MCP configuration file (claude_desktop_config.json) in Claude Desktop Developer in (File > Settings > Developer > Edit Config)
+<div style="padding-left: 10px;">
 
-To configure Windsurf IDE:
-- Open the MCP configuration file (mcp_config.json) in Windsurf IDE in (Windsurf Settings > Advanced Settings > General > Add Sever)
+Open the MCP configuration file (mcp_config.json) in Windsurf IDE in (Windsurf Settings > Advanced Settings > General > Add Server)
 
 ```json
 {
-  "mcpServers": {
-    "mcp-unity": {
+   "mcpServers": {
+   "mcp-unity": {
       "command": "node",
       "args": [
-        "ABSOLUTE/PATH/TO/mcp-unity/Server/build/index.js"
+         "ABSOLUTE/PATH/TO/mcp-unity/Server/build/index.js"
       ],
       "env": {
-        "UNITY_PORT": "8090"
+         "UNITY_PORT": "8090"
       }
-    }
-  }
+   }
+   }
 }
 ```
+</div>
 
-## Running the Server
-You need to run the MCP Unity server for this to work, in the following ways:
+</details>
 
-### Start Node.js Server
+<details>
+<summary><span style="font-size: 1em">Option 3.3: Configure Cursor IDE</span></summary>
 
-1. Navigate to this `mcp-unity` package directory in your device with the terminal.
-   ```bash
-   cd ABSOLUTE/PATH/TO/mcp-unity
-   ```
-2. Run the server using Node.js:
-   ```bash
-   node Server/build/index.js
-   ```
+<div style="padding-left: 10px;">
+
+Add the following configuration to your Cursor MCP Configure settings:
+
+```
+Name: MCP Unity
+Type: commmand
+Command: env UNITY_PORT=8090 node ABSOLUTE/PATH/TO/mcp-unity/Server/build/index.js
+```
+</div>
 
-### Start Unity Editor MCP Server
+</details>
+</div>
+
+</details>
+
+## <a name="start-server"></a>Start Unity Editor MCP Server
 1. Open the Unity Editor
 2. Navigate to Tools > MCP Unity > Server Window
 3. Click "Start Server" to start the WebSocket server
+4. Open Claude Desktop or your AI Coding IDE (e.g. Cursor IDE, Windsurf IDE, etc.) and start executing Unity tools
 
 ![connect](https://github.com/user-attachments/assets/2e266a8b-8ba3-4902-b585-b220b11ab9a2)
 
 ## Configure the WebSocket Port
 By default, the WebSocket server runs on port 8080. You can change this port in two ways:
 
-### Option 1: Using the Unity Editor
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Option 1: Using the Unity Editor</span></summary>
+
 1. Open the Unity Editor
 2. Navigate to Tools > MCP Unity > Server Window
 3. Change the "WebSocket Port" value to your desired port number
 4. Unity will setup the system environment variable UNITY_PORT to the new port number
 5. Restart the Node.js server
 6. Click again on "Start Server" to reconnect the Unity Editor web socket to the Node.js MCP Server
 
-### Option 2: Change the system environment variable UNITY_PORT in the terminal
+</details>
+
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Option 2: Using the terminal</span></summary>
+
 1. Set the UNITY_PORT environment variable in the terminal
    - Powershell
    ```powershell
@@ -205,8 +254,14 @@ By default, the WebSocket server runs on port 8080. You can change this port in
 2. Restart the Node.js server
 3. Click again on "Start Server" to reconnect the Unity Editor web socket to the Node.js MCP Server
 
-## Building and Debugging the Server
-The MCP Unity server is built using Node.js and TypeScript. It requires to compile the TypeScript code to JavaScript in the `build` directory.
+</details>
+
+## <a name="debug-server"></a>Debugging the Server
+
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Building the Node.js Server</span></summary>
+
+The MCP Unity server is built using Node.js . It requires to compile the TypeScript code to JavaScript in the `build` directory.
 To build the server, open a terminal and:
 
 1. Navigate to the Server directory:
@@ -224,9 +279,17 @@ To build the server, open a terminal and:
    npm run build
    ```
 
-### Debugging
+4. Run the server:
+   ```bash
+   node build/index.js
+   ```
+
+</details>
 
-1. Debug the server with [@modelcontextprotocol/inspector](https://github.com/modelcontextprotocol/inspector):
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Debugging with MCP Inspector</span></summary>
+
+Debug the server with [@modelcontextprotocol/inspector](https://github.com/modelcontextprotocol/inspector):
    - Powershell
    ```powershell
    $env:UNITY_PORT=8090; npx @modelcontextprotocol/inspector node Server/build/index.js
@@ -236,7 +299,14 @@ To build the server, open a terminal and:
    set UNITY_PORT=8090 && npx @modelcontextprotocol/inspector node Server/build/index.js
    ```
 
-2. Enable logging on your terminal or into a log.txt file:
+Don't forget to shutdown the server with `Ctrl + C` before closing the terminal or debugging it with the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
+
+</details>
+
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Enable Console Logs</span></summary>
+
+1. Enable logging on your terminal or into a log.txt file:
    - Powershell
    ```powershell
    $env:LOGGING = "true"
@@ -248,25 +318,40 @@ To build the server, open a terminal and:
    set LOGGING_FILE=true
    ```
 
-Don't forget to shutdown the server with `Ctrl + C` before closing the terminal or debugging it with the [@modelcontextprotocol/inspector](https://github.com/modelcontextprotocol/inspector).
+</details>
 
 ## Troubleshooting
 
-### Connection Issues
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Connection Issues</span></summary>
+
 - Ensure the WebSocket server is running (check the Server Window in Unity)
 - Check if there are any firewall restrictions blocking the connection
 - Make sure the port number is correct (default is 8080)
 - Change the port number in the Unity Editor MCP Server window. (Tools > MCP Unity > Server Window)
+</details>
+
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Server Not Starting</span></summary>
 
-### Server Not Starting
 - Check the Unity Console for error messages
 - Ensure Node.js is properly installed and accessible in your PATH
 - Verify that all dependencies are installed in the Server directory
+</details>
+
+<details>
+<summary><span style="font-size: 1.1em; font-weight: bold;">Menu Items Not Executing</span></summary>
 
-### Menu Items Not Executing
 - Ensure the menu item path is correct (case-sensitive)
 - Check if the menu item requires confirmation
 - Verify that the menu item is available in the current context
+</details>
+
+## Support & Feedback
+
+If you have any questions or need support, please open an [issue](https://github.com/CoderGamester/mcp-unity/issues) on this repository.
+
+Alternative you can reach out on [![](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white 'LinkedIn')](https://www.linkedin.com/in/miguel-tomas/)
 
 ## Contributing
 
@@ -276,4 +361,4 @@ Contributions are welcome! Please feel free to submit a Pull Request or open an
 
 ## License
 
-This project is under MIT license
+This project is under [MIT License](License.md)