mcpforunityserver 8.6.0__tar.gz

mcpforunityserver-8.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CoplayDev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mcpforunityserver-8.6.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: mcpforunityserver
+Version: 8.6.0
+Summary: MCP for Unity Server: A Unity package for Unity Editor integration via the Model Context Protocol (MCP).
+Author-email: Marcus Sanatan <msanatan@gmail.com>, David Sarno <david.sarno@gmail.com>, Wu Shutong <martinwfire@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/CoplayDev/unity-mcp.git
+Project-URL: Issues, https://github.com/CoplayDev/unity-mcp/issues
+Keywords: mcp,unity,ai,model context protocol,gamedev,unity3d,automation,llm,agent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: fastmcp==2.14.1
+Requires-Dist: mcp>=1.16.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: tomli>=2.3.0
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: uvicorn>=0.35.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# MCP for Unity Server
+
+[![MCP](https://badge.mcpx.dev?status=on 'MCP Enabled')](https://modelcontextprotocol.io/introduction)
+[![python](https://img.shields.io/badge/Python-3.10+-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
+[![License](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
+[![Discord](https://img.shields.io/badge/discord-join-red.svg?logo=discord&logoColor=white)](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. You also need `uvx` (requires [uv](https://docs.astral.sh/uv/)) to run the server.
+
+---
+
+## Installation
+
+### Option 1: PyPI
+
+Install and run directly from PyPI using `uvx`.
+
+**Run Server (HTTP):**
+
+```bash
+uvx --from mcpforunityserver mcp-for-unity --transport http --http-url http://localhost:8080
+```
+
+**MCP Client Configuration (HTTP):**
+
+```json
+{
+  "mcpServers": {
+    "UnityMCP": {
+      "url": "http://localhost:8080/mcp"
+    }
+  }
+}
+```
+
+**MCP Client Configuration (stdio):**
+
+```json
+{
+  "mcpServers": {
+    "UnityMCP": {
+      "command": "uvx",
+      "args": [
+        "--from",
+        "mcpforunityserver",
+        "mcp-for-unity",
+        "--transport",
+        "stdio"
+      ]
+    }
+  }
+}
+```
+
+### Option 2: From GitHub Source
+
+Use this to run the latest released version from the repository. Change the version to `main` to run the latest unreleased changes from the repository.
+
+```json
+{
+  "mcpServers": {
+    "UnityMCP": {
+      "command": "uvx",
+      "args": [
+        "--from",
+        "git+https://github.com/CoplayDev/unity-mcp@v8.6.0#subdirectory=Server",
+        "mcp-for-unity",
+        "--transport",
+        "stdio"
+      ]
+    }
+  }
+}
+```
+
+### Option 3: Docker
+
+**Use Pre-built Image:**
+
+```bash
+docker run -p 8080:8080 msanatan/mcp-for-unity-server:latest --transport http --http-url http://0.0.0.0:8080
+```
+
+**Build Locally:**
+
+```bash
+docker build -t unity-mcp-server .
+docker run -p 8080:8080 unity-mcp-server --transport http --http-url http://0.0.0.0:8080
+```
+
+Configure your MCP client with `"url": "http://localhost:8080/mcp"`.
+
+### Option 4: Local Development
+
+For contributing or modifying the server code:
+
+```bash
+# Clone the repository
+git clone https://github.com/CoplayDev/unity-mcp.git
+cd unity-mcp/Server
+
+# Run with uv
+uv run src/main.py --transport stdio
+```
+
+---
+
+## Configuration
+
+The server connects to Unity Editor automatically when both are running. No additional configuration needed.
+
+**Environment Variables:**
+
+- `DISABLE_TELEMETRY=true` - Opt out of anonymous usage analytics
+- `LOG_LEVEL=DEBUG` - Enable detailed logging (default: INFO)
+
+---
+
+## 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:
+
+📖 **[Full Documentation](https://github.com/CoplayDev/unity-mcp#readme)**
+
+---
+
+## Requirements
+
+- **Python:** 3.10 or newer
+- **Unity Editor:** 2021.3 LTS or newer
+- **uv:** Python package manager ([Installation Guide](https://docs.astral.sh/uv/getting-started/installation/))
+
+---
+
+## License
+
+MIT License - See [LICENSE](https://github.com/CoplayDev/unity-mcp/blob/main/LICENSE)

mcpforunityserver-8.6.0/README.md

@@ -0,0 +1,155 @@
+# MCP for Unity Server
+
+[![MCP](https://badge.mcpx.dev?status=on 'MCP Enabled')](https://modelcontextprotocol.io/introduction)
+[![python](https://img.shields.io/badge/Python-3.10+-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
+[![License](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
+[![Discord](https://img.shields.io/badge/discord-join-red.svg?logo=discord&logoColor=white)](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. You also need `uvx` (requires [uv](https://docs.astral.sh/uv/)) to run the server.
+
+---
+
+## Installation
+
+### Option 1: PyPI
+
+Install and run directly from PyPI using `uvx`.
+
+**Run Server (HTTP):**
+
+```bash
+uvx --from mcpforunityserver mcp-for-unity --transport http --http-url http://localhost:8080
+```
+
+**MCP Client Configuration (HTTP):**
+
+```json
+{
+  "mcpServers": {
+    "UnityMCP": {
+      "url": "http://localhost:8080/mcp"
+    }
+  }
+}
+```
+
+**MCP Client Configuration (stdio):**
+
+```json
+{
+  "mcpServers": {
+    "UnityMCP": {
+      "command": "uvx",
+      "args": [
+        "--from",
+        "mcpforunityserver",
+        "mcp-for-unity",
+        "--transport",
+        "stdio"
+      ]
+    }
+  }
+}
+```
+
+### Option 2: From GitHub Source
+
+Use this to run the latest released version from the repository. Change the version to `main` to run the latest unreleased changes from the repository.
+
+```json
+{
+  "mcpServers": {
+    "UnityMCP": {
+      "command": "uvx",
+      "args": [
+        "--from",
+        "git+https://github.com/CoplayDev/unity-mcp@v8.6.0#subdirectory=Server",
+        "mcp-for-unity",
+        "--transport",
+        "stdio"
+      ]
+    }
+  }
+}
+```
+
+### Option 3: Docker
+
+**Use Pre-built Image:**
+
+```bash
+docker run -p 8080:8080 msanatan/mcp-for-unity-server:latest --transport http --http-url http://0.0.0.0:8080
+```
+
+**Build Locally:**
+
+```bash
+docker build -t unity-mcp-server .
+docker run -p 8080:8080 unity-mcp-server --transport http --http-url http://0.0.0.0:8080
+```
+
+Configure your MCP client with `"url": "http://localhost:8080/mcp"`.
+
+### Option 4: Local Development
+
+For contributing or modifying the server code:
+
+```bash
+# Clone the repository
+git clone https://github.com/CoplayDev/unity-mcp.git
+cd unity-mcp/Server
+
+# Run with uv
+uv run src/main.py --transport stdio
+```
+
+---
+
+## Configuration
+
+The server connects to Unity Editor automatically when both are running. No additional configuration needed.
+
+**Environment Variables:**
+
+- `DISABLE_TELEMETRY=true` - Opt out of anonymous usage analytics
+- `LOG_LEVEL=DEBUG` - Enable detailed logging (default: INFO)
+
+---
+
+## 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:
+
+📖 **[Full Documentation](https://github.com/CoplayDev/unity-mcp#readme)**
+
+---
+
+## Requirements
+
+- **Python:** 3.10 or newer
+- **Unity Editor:** 2021.3 LTS or newer
+- **uv:** Python package manager ([Installation Guide](https://docs.astral.sh/uv/getting-started/installation/))
+
+---
+
+## License
+
+MIT License - See [LICENSE](https://github.com/CoplayDev/unity-mcp/blob/main/LICENSE)

mcpforunityserver-8.6.0/pyproject.toml

@@ -0,0 +1,56 @@
+[project]
+name = "mcpforunityserver"
+version = "8.6.0"
+description = "MCP for Unity Server: A Unity package for Unity Editor integration via the Model Context Protocol (MCP)."
+readme = "README.md"
+license = "MIT"
+authors = [
+    {name = "Marcus Sanatan", email = "msanatan@gmail.com"},
+    {name = "David Sarno", email = "david.sarno@gmail.com"},
+    {name = "Wu Shutong", email = "martinwfire@gmail.com"}
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Games/Entertainment",
+    "Topic :: Software Development :: Code Generators",
+]
+keywords = ["mcp", "unity", "ai", "model context protocol", "gamedev", "unity3d", "automation", "llm", "agent"]
+requires-python = ">=3.10"
+dependencies = [
+ "httpx>=0.27.2",
+ "fastmcp==2.14.1",
+ "mcp>=1.16.0",
+ "pydantic>=2.12.5",
+ "tomli>=2.3.0",
+ "fastapi>=0.104.0",
+ "uvicorn>=0.35.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23",
+]
+
+[project.urls]
+Repository = "https://github.com/CoplayDev/unity-mcp.git"
+Issues = "https://github.com/CoplayDev/unity-mcp/issues"
+
+[project.scripts]
+mcp-for-unity = "main:main"
+
+[build-system]
+requires = ["setuptools>=64.0.0", "wheel"]
+build-backend = "setuptools.build_meta"

mcpforunityserver-8.6.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mcpforunityserver-8.6.0/src/core/config.py

@@ -0,0 +1,56 @@
+"""
+Configuration settings for the MCP for Unity Server.
+This file contains all configurable parameters for the server.
+"""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class ServerConfig:
+    """Main configuration class for the MCP server."""
+
+    # Network settings
+    unity_host: str = "localhost"
+    unity_port: int = 6400
+    mcp_port: int = 6500
+
+    # Connection settings
+    connection_timeout: float = 30.0
+    buffer_size: int = 16 * 1024 * 1024  # 16MB buffer
+
+    # STDIO framing behaviour
+    require_framing: bool = True
+    handshake_timeout: float = 1.0
+    framed_receive_timeout: float = 2.0
+    max_heartbeat_frames: int = 16
+    heartbeat_timeout: float = 2.0
+
+    # Logging settings
+    log_level: str = "INFO"
+    log_format: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+
+    # Server settings
+    max_retries: int = 5
+    retry_delay: float = 0.25
+    # Backoff hint returned to clients when Unity is reloading (milliseconds)
+    reload_retry_ms: int = 250
+    # Number of polite retries when Unity reports reloading
+    # 40 × 250ms ≈ 10s default window
+    reload_max_retries: int = 40
+
+    # Port discovery cache
+    port_registry_ttl: float = 5.0
+
+    # Telemetry settings
+    telemetry_enabled: bool = True
+    # Align with telemetry.py default Cloud Run endpoint
+    telemetry_endpoint: str = "https://api-prod.coplay.dev/telemetry/events"
+
+    def configure_logging(self) -> None:
+        level = getattr(logging, self.log_level, logging.INFO)
+        logging.basicConfig(level=level, format=self.log_format)
+
+
+# Create a global config instance
+config = ServerConfig()

mcpforunityserver-8.6.0/src/core/logging_decorator.py

@@ -0,0 +1,37 @@
+import functools
+import inspect
+import logging
+from typing import Callable, Any
+
+logger = logging.getLogger("mcp-for-unity-server")
+
+
+def log_execution(name: str, type_label: str):
+    """Decorator to log input arguments and return value of a function."""
+    def decorator(func: Callable) -> Callable:
+        @functools.wraps(func)
+        def _sync_wrapper(*args, **kwargs) -> Any:
+            logger.info(
+                f"{type_label} '{name}' called with args={args} kwargs={kwargs}")
+            try:
+                result = func(*args, **kwargs)
+                logger.info(f"{type_label} '{name}' returned: {result}")
+                return result
+            except Exception as e:
+                logger.info(f"{type_label} '{name}' failed: {e}")
+                raise
+
+        @functools.wraps(func)
+        async def _async_wrapper(*args, **kwargs) -> Any:
+            logger.info(
+                f"{type_label} '{name}' called with args={args} kwargs={kwargs}")
+            try:
+                result = await func(*args, **kwargs)
+                logger.info(f"{type_label} '{name}' returned: {result}")
+                return result
+            except Exception as e:
+                logger.info(f"{type_label} '{name}' failed: {e}")
+                raise
+
+        return _async_wrapper if inspect.iscoroutinefunction(func) else _sync_wrapper
+    return decorator