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
Copy file name to clipboardExpand all lines: README.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,22 +50,22 @@ MCP Unity is an implementation of the Model Context Protocol for Unity Editor, a
50
50
## Features
51
51
MCP Unity currently provides the following tools:
52
52
53
-
-**execute_menu_item**: Executes Unity menu items (functions tagged with the MenuItem attribute)
54
-
-**select_gameobject**: Selects game objects in the Unity hierarchy by path or instance ID
55
-
-**update_component**: Updates component fields on a GameObject or adds it to the GameObject if it does not contain the component
56
-
-**package_manager**: Installs, removes, and updates packages in the Unity Package Manager
57
-
-**run_tests**: Runs tests using the Unity Test Runner
58
-
-**notify_message**: Displays messages in the Unity Editor
53
+
-__**execute_menu_item**__: Executes Unity menu items (functions tagged with the MenuItem attribute)
54
+
-__**select_gameobject**__: Selects game objects in the Unity hierarchy by path or instance ID
55
+
-__**update_component**__: Updates component fields on a GameObject or adds it to the GameObject if it does not contain the component
56
+
-__**package_manager**__: Installs, removes, and updates packages in the Unity Package Manager
57
+
-__**run_tests**__: Runs tests using the Unity Test Runner
58
+
-__**notify_message**__: Displays messages in the Unity Editor
59
59
60
60
MCP Unity currently provides the following resources:
61
61
62
-
-**get_menu_items**: Retrieves a list of all available menu items in the Unity Editor to facilitate **execute_menu_item** tool
63
-
-**get_hierarchy**: Retrieves a list of all game objects in the Unity hierarchy
64
-
-**get_gameobject**: Retrieves detailed information about a specific GameObject by instance ID, including all GameObject components with it's serialized properties and fields
65
-
-**get_console_logs**: Retrieves a list of all logs from the Unity console
66
-
-**get_packages**: Retrieves information about installed and available packages from the Unity Package Manager
67
-
-**get_assets**: Retrieves information about assets in the Unity Asset Database
68
-
-**get_tests**: Retrieves information about tests in the Unity Test Runner
62
+
-__**get_menu_items**__: Retrieves a list of all available menu items in the Unity Editor to facilitate __**execute_menu_item**__ tool
63
+
-__**get_hierarchy**__: Retrieves a list of all game objects in the Unity hierarchy
64
+
-__**get_gameobject**__: Retrieves detailed information about a specific GameObject by instance ID, including all GameObject components with it's serialized properties and fields
65
+
-__**get_console_logs**__: Retrieves a list of all logs from the Unity console
66
+
-__**get_packages**__: Retrieves information about installed and available packages from the Unity Package Manager
67
+
-__**get_assets**__: Retrieves information about assets in the Unity Asset Database
68
+
-__**get_tests**__: Retrieves information about tests in the Unity Test Runner
69
69
70
70
## Requirements
71
71
- Unity 2022.3 or later - to [install the server](#install-server)
@@ -122,9 +122,10 @@ Installing this MCP Unity Server is a multi-step process:
122
122
<detailsopen>
123
123
<summary><spanstyle="font-size: 1.1em; font-weight: bold;">Option 1: Configure using Unity Editor</span></summary>
124
124
125
-
> Replace `ABSOLUTE/PATH/TO` with the absolute path to your MCP Unity installation.
126
-
127
-
The right configuration can be accessed in the Unity Editor MCP Server window (Tools > MCP Unity > Server Window)
125
+
1. Open the Unity Editor
126
+
2. Navigate to Tools > MCP Unity > Server Window
127
+
3. Click on the "Configure" button for your AI LLM client as shown in the image below
128
+
4. Confirm the configuration installation with the given popup
0 commit comments