Unity MCP Server

Integrations

  • Supports deployment through Docker with configuration options, allowing the server to be containerized and run in isolated environments.

  • Enables repository interactions for cloning the Unity MCP server codebase as part of the installation process.

  • Supports accessing and cloning the Unity MCP server repository from GitHub as part of the setup workflow.

Unity MCP Server for Smithery.ai

A comprehensive Model Context Protocol (MCP) server for Unity game development that provides tools for project management, scene editing, prefab creation, script generation, and more.

Features

  • Project Management: Create and open Unity projects
  • Scene Editing: Create and modify Unity scenes
  • Prefab Creation: Generate prefabs with customizable components
  • Script Generation: Create C# scripts using various templates (MonoBehaviour, ScriptableObject, EditorWindow)
  • Smithery.ai Integration: Full compatibility with Smithery.ai platform

Getting Started

Prerequisites

  • Node.js 18 or higher
  • Unity installed (for actual Unity operations)

Installation

  1. Clone the repository:
git clone https://github.com/GrandMasterK414/unity-mcp-server.git cd unity-mcp-server
  1. Install dependencies:
npm install
  1. Build the project:
npm run build

Running the Server

Local Development

npm run dev

Smithery.ai Deployment

npm run smithery:start

Or using Docker:

docker-compose up -d

Configuration

The server can be configured through environment variables:

  • SMITHERY: Set to "true" to enable Smithery mode (uses WebSocket transport)
  • PORT: WebSocket server port (default: 3000)
  • UNITY_PROJECTS_PATH: Directory to store Unity projects
  • SCRIPT_ROOT: Directory to store script templates

API Tools

Create Unity Project

Creates a new Unity project with specified configuration.

{ "name": "MyGameProject", "path": "./projects", "unityVersion": "2022.3.5f1" }

Open Unity Project

Opens an existing Unity project.

{ "path": "./projects/MyGameProject" }

Create Unity Scene

Creates a new Unity scene.

{ "name": "MainLevel", "projectPath": "./projects/MyGameProject" }

Create Unity Prefab

Creates a new Unity prefab.

{ "name": "EnemyCharacter", "projectPath": "./projects/MyGameProject", "components": ["Rigidbody", "MeshRenderer", "BoxCollider"] }

Generate Unity Script

Generates a new C# script for Unity.

{ "name": "PlayerController", "projectPath": "./projects/MyGameProject", "scriptType": "MonoBehaviour", "template": "// Optional custom template content" }

Docker Support

The server can be deployed using Docker:

# Build the Docker image docker build -t unity-mcp-server . # Run the container docker run -p 3000:3000 -d unity-mcp-server

License

This project is licensed under the MIT License - see the LICENSE file for details.

-
security - not tested
F
license - not found
-
quality - not tested

A Model Context Protocol server for Unity game development that enables users to manage projects, edit scenes, create prefabs, and generate scripts through natural language integration with Smithery.ai.

  1. Features
    1. Getting Started
      1. Prerequisites
      2. Installation
      3. Running the Server
    2. Configuration
      1. API Tools
        1. Create Unity Project
        2. Open Unity Project
        3. Create Unity Scene
        4. Create Unity Prefab
        5. Generate Unity Script
      2. Docker Support
        1. License
          ID: x6qf49foir