npm package: @playcanvas/editor-mcp-server
Description: The PlayCanvas Editor MCP Server
Author: PlayCanvas
Latest version: 0.1.0

    ██████╗ ██╗      █████╗ ██╗   ██╗ ██████╗ █████╗ ███╗   ██╗██╗   ██╗ █████╗ ███████╗
    ██╔══██╗██║     ██╔══██╗╚██╗ ██╔╝██╔════╝██╔══██╗████╗  ██║██║   ██║██╔══██╗██╔════╝
    ██████╔╝██║     ███████║ ╚████╔╝ ██║     ███████║██╔██╗ ██║██║   ██║███████║███████╗
    ██╔═══╝ ██║     ██╔══██║  ╚██╔╝  ██║     ██╔══██║██║╚██╗██║╚██╗ ██╔╝██╔══██║╚════██║
    ██║     ███████╗██║  ██║   ██║   ╚██████╗██║  ██║██║ ╚████║ ╚████╔╝ ██║  ██║███████║
    ╚═╝     ╚══════╝╚═╝  ╚═╝   ╚═╝    ╚═════╝╚═╝  ╚═╝╚═╝  ╚═══╝  ╚═══╝  ╚═╝  ╚═╝╚══════╝

    ███╗   ███╗ ██████╗██████╗        ███████╗███████╗██████╗ ██╗   ██╗███████╗██████╗ 
    ████╗ ████║██╔════╝██╔══██╗       ██╔════╝██╔════╝██╔══██╗██║   ██║██╔════╝██╔══██╗
    ██╔████╔██║██║     ██████╔╝       ███████╗█████╗  ██████╔╝██║   ██║█████╗  ██████╔╝
    ██║╚██╔╝██║██║     ██╔═══╝        ╚════██║██╔══╝  ██╔══██╗╚██╗ ██╔╝██╔══╝  ██╔══██╗
    ██║ ╚═╝ ██║╚██████╗██║            ███████║███████╗██║  ██║ ╚████╔╝ ███████╗██║  ██║
    ╚═╝     ╚═╝ ╚═════╝╚═╝            ╚══════╝╚══════╝╚═╝  ╚═╝  ╚═══╝  ╚══════╝╚═╝  ╚═╝

An MCP Server for automating the [PlayCanvas Editor](https://playcanvas.com/products/editor) using an LLM.

<img width="1864" alt="Screenshot 2025-03-21 at 15 50 10" src="https://github.com/user-attachments/assets/393ffe73-40eb-4e1b-9442-2295bbb63326" />

> [!IMPORTANT]  
> At the moment, the MCP Server needs to be driven by Anthropic's Claude. Our experience shows that the free tier for Claude does not deliver a big enough chat context to operate the MCP Server reliably. Therefore, we strongly recommend subscribing to a Pro Claude account.

## Available Tools

* Entity
  * `list_entities`
  * `create_entities`
  * `delete_entities`
  * `duplicate_entities`
  * `modify_entities`
  * `reparent_entity`
  * `add_components`
  * `remove_components`
  * `add_script_component_script`
* Asset
  * `list_assets`
  * `create_assets`
  * `delete_assets`
  * `instantiate_template_assets`
  * `set_script_text`
  * `script_parse`
  * `set_material_diffuse`
* Scene
  * `query_scene_settings`
  * `modify_scene_settings`
* Store
  * `store_search`
  * `store_get`
  * `store_download`
* Viewport
  * `capture_viewport`
  * `focus_viewport`

## Installation

Run `npm install` to install all dependencies.

### Install Chrome Extension

1. Visit `chrome://extensions/` and enable Developer mode
2. Click `Load unpacked` and select the `extension` folder
3. Load the PlayCanvas Editor. The extension should be loaded.

### Run MCP Server

The MCP Server can be driven by Cursor or Claude Desktop.

> [!TIP]  
> We have found Claude Desktop to be generally more reliable.

#### Claude Desktop

1. Install [Claude Desktop](https://claude.ai/download).
2. Go to `Claude` > `Settings`.
3. Select `Developer` and then `Edit Config`.
4. This will open `claude_desktop_config.json`, your MCP Config JSON file.

#### Cursor

1. Install [Cursor](https://www.cursor.com/).
2. Select `File` > `Preferences` > `Cursor Settings`.
3. Click `+ Add new global MCP server`.
4. This will open `mcp.json`, your MCP Config JSON file.

> [!TIP]  
> Also in `Cursor Settings`, select `Features` and scroll to the `Chat` section. Activate `Enable auto-run mode` to allow the LLM to run MCP tools without requiring constant authorization. You do this at your own risk (but we prefer it)!

> [!IMPORTANT]  
> In Cursor, ensure you have `Agent` selected. `Ask` and `Edit` modes will not recognize the MCP Server.

#### MCP Config JSON File

This is how your config should look:

Windows

```json
{
  "mcpServers": {
    "playcanvas": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "tsx",
        "C:\\path\\to\\editor-mcp-server\\src\\server.ts"
      ],
      "env": {
        "PORT": "52000"
      }
    }
  }
}
```

macOS

```json
{
  "mcpServers": {
    "playcanvas": {
      "command": "npx",
      "args": [
        "tsx",
        "/path/to/editor-mcp-server/src/server.ts"
      ],
      "env": {
        "PORT": "52000"
      }
    }
  }
}
```

## Connecting the Editor to the MCP Server

The PlayCanvas Editor does not connect to the MCP Server automatically. To connect:

1. Activate a Chrome tab running the PlayCanvas Editor.
2. Select the Extensions icon to the right of the address bar.
3. Select PlayCanvas Editor MCP Extension to open the extension popup.
4. Select `CONNECT` (the port number should match what is set in your MCP Config JSON File).

> [!NOTE]
> You can currently only connect one instance of the PlayCanvas Editor to the MCP Server at any one time.

You should now be able to issue commands in Claude Desktop or Cursor.