Unity MCP Server logo

Unity MCP Server

by GrandMasterK414

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. It offers full compatibility with the Smithery.ai platform.

View on GitHub

Last updated: N/A

What is Unity MCP Server?

The Unity MCP Server is a Model Context Protocol server designed to enhance Unity game development workflows. It provides a suite of API tools for project management, scene editing, prefab creation, and script generation, supporting seamless integration with platforms like Smithery.ai.

How to use Unity MCP Server?

To use the server, clone the repository, install dependencies using npm install, and build the project with npm run build. You can then run the server locally using npm run dev or deploy it with npm run smithery:start for Smithery.ai environments or use Docker. Configure the server using environment variables like SMITHERY, PORT, UNITY_PROJECTS_PATH, and SCRIPT_ROOT. Use the provided API endpoints with JSON payloads to manage Unity projects, scenes, prefabs, and scripts.

Key features of Unity MCP Server

  • 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

Use cases of Unity MCP Server

  • Automated Unity project setup and management

  • Streamlined scene creation and modification workflows

  • Programmatic prefab generation for large-scale game content

  • Rapid C# script creation using templates

  • Integration with AI-powered game development platforms like Smithery.ai

FAQ from Unity MCP Server

What is MCP?

MCP stands for Model Context Protocol, a protocol for communication and data exchange between tools and platforms related to game development.

What Node.js Version is required?

Node.js 18 or higher.

How to enable Smithery.ai mode?

Set the SMITHERY environment variable to true.

What is the default WebSocket server port?

The default WebSocket server port is 3000.

Where are script templates stored?

Script templates are stored in the directory specified by the SCRIPT_ROOT environment variable.