89 lines
2.4 KiB
Markdown
89 lines
2.4 KiB
Markdown
|
# MCP for Unity Server (Docker Image)
|
||
|
|
|
||
|
|
[](https://modelcontextprotocol.io/introduction)
|
||
|
|
[](https://opensource.org/licenses/MIT)
|
||
|
|
[](https://discord.gg/y4p8KfzrN4)
|
||
|
|
|
||
|
|
Model Context Protocol server for Unity Editor integration. Control Unity through natural language using AI assistants like Claude, Cursor, and more.
|
||
|
|
|
||
|
|
**Maintained by [Coplay](https://www.coplay.dev/?ref=unity-mcp)** - This project is not affiliated with Unity Technologies.
|
||
|
|
|
||
|
|
💬 **Join our community:** [Discord Server](https://discord.gg/y4p8KfzrN4)
|
||
|
|
|
||
|
|
**Required:** Install the [Unity MCP Plugin](https://github.com/CoplayDev/unity-mcp?tab=readme-ov-file#-step-1-install-the-unity-package) to connect Unity Editor with this MCP server.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
|
||
|
|
### 1. Pull the image
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docker pull msanatan/mcp-for-unity-server:latest
|
||
|
|
```
|
||
|
|
|
||
|
|
### 2. Run the server
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docker run -p 8080:8080 msanatan/mcp-for-unity-server:latest
|
||
|
|
```
|
||
|
|
|
||
|
|
This starts the MCP server on port 8080.
|
||
|
|
|
||
|
|
### 3. Configure your MCP Client
|
||
|
|
|
||
|
|
Add the following configuration to your MCP client (e.g., Claude Desktop config, Cursor settings):
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"mcpServers": {
|
||
|
|
"UnityMCP": {
|
||
|
|
"url": "http://localhost:8080/mcp"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
The server connects to the Unity Editor automatically when both are running. No additional configuration is needed.
|
||
|
|
|
||
|
|
**Environment Variables:**
|
||
|
|
|
||
|
|
- `DISABLE_TELEMETRY=true` - Opt out of anonymous usage analytics
|
||
|
|
- `LOG_LEVEL=DEBUG` - Enable detailed logging (default: INFO)
|
||
|
|
|
||
|
|
Example running with environment variables:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docker run -p 8080:8080 -e LOG_LEVEL=DEBUG msanatan/mcp-for-unity-server:latest
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Example Prompts
|
||
|
|
|
||
|
|
Once connected, try these commands in your AI assistant:
|
||
|
|
|
||
|
|
- "Create a 3D player controller with WASD movement"
|
||
|
|
- "Add a rotating cube to the scene with a red material"
|
||
|
|
- "Create a simple platformer level with obstacles"
|
||
|
|
- "Generate a shader that creates a holographic effect"
|
||
|
|
- "List all GameObjects in the current scene"
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
For complete documentation, troubleshooting, and advanced usage, please visit the GitHub repository:
|
||
|
|
|
||
|
|
📖 **[Full Documentation](https://github.com/CoplayDev/unity-mcp#readme)**
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT License - See [LICENSE](https://github.com/CoplayDev/unity-mcp/blob/main/LICENSE)
|