Unity

You enable an AI-assisted workflow inside Unity by running a Model Context Protocol (MCP) server that exposes Unity project actions over HTTP. This server lets you manipulate scenes, GameObjects, components, transforms, and more from an AI client, with live access to project context and results to power intelligent guidance and automation.

How to use

Connect your MCP client to the Unity MCP Server using the HTTP endpoint you configure in the server settings. The default and recommended access point is http://127.0.0.1:5173/mcp. From your client, you can request operations such as loading scenes, modifying GameObjects, changing component properties, updating transforms, inspecting project structure, running tests, and reading live console output.

How to install

Prerequisites you need before installing the MCP server:

• Unity Editor (version 6 or later) and a compatible runtime environment.

• Node.js 18 or later.

Install the MCP package into your Unity project using one of the following methods.

Install via Git URL (Package Manager)

Window > Package Manager
Click the + button > Add package from git URL
Enter: https://github.com/Singtaa/UnityMCP.git

Install via git submodule

git submodule add https://github.com/Singtaa/UnityMCP.git Packages/com.singtaa.unity-mcp

Configure and run the server

Once installed, open the Unity MCP Server window to monitor and configure the server. The server starts automatically when Unity launches if you enable Auto Start in the configuration.

Set the connection URL in your MCP client to the server’s HTTP address, for example http://127.0.0.1:5173/mcp.

Notes on startup and ports

The server exposes an HTTP API on port 5173 and a Unity-Node TCP bridge on port 52100 by default. You can adjust these via the MCP settings file at ProjectSettings/McpSettings.json.

Additional configuration

The MCP settings file stores configurable options such as ports and authentication. Typical settings include: HTTP Port (default 5173), IPC Port (default 52100), Auto Start (default true), and Auth Enabled (default true). Change these only after understanding your security and network requirements.

Security considerations

By default, authentication is enabled to require a bearer token for API access. Manage credentials securely in your MCP client and keep the server on a trusted network to minimize exposure.

Troubleshooting

If the server does not start automatically, confirm that Unity is launching with the MCP package installed and that Auto Start is enabled in the settings. Check the console output for any startup errors and verify that the HTTP endpoint is reachable at the configured port.

Available tools

unity_scene_list

List all loaded scenes in the active Unity project.

unity_scene_load

Load a specific scene by name or path.

unity_scene_save

Save one or more scenes to persist changes.

unity_scene_new

Create a new scene.

unity_scene_close

Close a loaded scene.

unity_gameobject_create

Create one or more GameObjects, with optional primitive shapes.

unity_gameobject_find

Find GameObjects by name, tag, or hierarchical path.

unity_gameobject_delete

Delete specified GameObjects.

unity_gameobject_set_active

Enable or disable a GameObject.

unity_gameobject_set_parent

Reparent a GameObject under a new parent.

unity_gameobject_rename

Rename a GameObject.

unity_gameobject_duplicate

Duplicate a GameObject.

unity_component_list

List components attached to a GameObject.

unity_component_add

Add a component to a GameObject.

unity_component_remove

Remove a component from a GameObject.

unity_component_set_enabled

Enable or disable a component.

unity_component_get_properties

Get properties of a component.

unity_component_set_property

Set a property on a component.

unity_transform_get

Get position, rotation, and scale of a transform.

unity_transform_set

Set position, rotation, and scale of a transform.

unity_transform_translate

Translate a transform by a delta.

unity_transform_rotate

Rotate a transform by Euler angles.

unity_transform_look_at

Orient a transform toward a target.

unity_transform_reset

Reset transform values to identity.

unity_editor_execute_menu_item

Execute a menu command in the editor.

unity_editor_notification

Show an editor notification.

unity_editor_log

Log messages to the Unity Console.

unity_editor_get_state

Query the editor state.

unity_editor_pause/step

Control playmode pause and step operations.

unity_undo_*

Perform undo/redo operations in the editor.

unity_prefab_load

Load a prefab asset for inspection or editing.

unity_prefab_save

Save changes to a prefab.

unity_prefab_get_hierarchy

Retrieve the full hierarchy of a prefab.

unity_prefab_find_component

Find a component inside a prefab by path.

unity_test_list

List available tests.

unity_test_run

Run tests asynchronously.

unity_test_run_sync

Run tests synchronously.

unity_test_get_results

Get test results.

unity_project_list_files

List files in the project.

unity_project_read_text

Read text from a file in the project.

unity_project_write_text

Write text to a file in the project.

unity_assets_refresh

Refresh the AssetDatabase.

unity_assets_import

Import specific assets into the project.