coplay-mcp-server 1.4.1__tar.gz

coplay_mcp_server-1.4.1/.gitignore

@@ -0,0 +1,175 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is recommended to ignore the entire .idea directory.
+.idea/
+
+# VS Code
+.vscode/
+
+# Logs
+logs/
+*.log
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

coplay_mcp_server-1.4.1/.python-version

@@ -0,0 +1 @@
+3.11

coplay_mcp_server-1.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Coplay Dev
+
+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.

coplay_mcp_server-1.4.1/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: coplay-mcp-server
+Version: 1.4.1
+Summary: A Model Context Protocol (MCP) server for Coplay, providing Unity integration capabilities
+Project-URL: Homepage, https://coplay.dev/
+Project-URL: Repository, https://github.com/CoplayDev/coplay-unity-plugin
+Project-URL: Documentation, https://docs.coplay.dev/
+Project-URL: Issues, https://github.com/CoplayDev/coplay-unity-plugin/issues
+Author-email: Coplay Dev <dev@coplay.com>
+Maintainer-email: Coplay Dev <dev@coplay.com>
+License: MIT
+License-File: LICENSE
+Keywords: coplay,mcp,model-context-protocol,unity,unity-editor
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: aiofiles>=24.1.0
+Requires-Dist: anyio>=4.10.0
+Requires-Dist: fastmcp>=2.0.0
+Requires-Dist: psutil>=7.0.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: watchdog>=6.0.0
+Description-Content-Type: text/markdown
+
+# Coplay MCP Server
+
+A Model Context Protocol (MCP) server for Coplay, providing Unity Editor integration capabilities through MCP tools.
+
+## Features
+
+- **Schema-Based Tool Registration**: Dynamically registers tools from JSON schema files, ensuring compatibility with Backend's AssistantMode.NORMAL
+- **Unity Project Discovery**: Automatically discover running Unity Editor instances and their project roots
+- **Unity Editor State**: Retrieve current Unity Editor state and scene hierarchy information
+- **Script Execution**: Execute arbitrary C# scripts within the Unity Editor
+- **Log Management**: Access and filter Unity console logs
+- **GameObject Hierarchy**: List and filter GameObjects in the scene hierarchy
+- **Task Creation**: Create new Coplay tasks directly from MCP clients
+- **Parameter Validation**: Automatic parameter validation and type conversion based on tool schemas
+- **Version Compatibility**: Tools are locked to specific schema versions, ensuring compatibility with Unity plugin versions
+
+## Usage
+
+### As an MCP server
+
+Add to your MCP client configuration:
+
+```json
+{
+  "mcpServers": {
+    "coplay-mcp": {
+      "autoApprove": [],
+      "disabled": false,
+      "timeout": 60,
+      "type": "stdio",
+      "command": "uvx",
+      "args": [
+        "coplay-mcp-server@latest"
+      ]
+    }
+  }
+}
+```
+
+

coplay_mcp_server-1.4.1/README.md

@@ -0,0 +1,40 @@
+# Coplay MCP Server
+
+A Model Context Protocol (MCP) server for Coplay, providing Unity Editor integration capabilities through MCP tools.
+
+## Features
+
+- **Schema-Based Tool Registration**: Dynamically registers tools from JSON schema files, ensuring compatibility with Backend's AssistantMode.NORMAL
+- **Unity Project Discovery**: Automatically discover running Unity Editor instances and their project roots
+- **Unity Editor State**: Retrieve current Unity Editor state and scene hierarchy information
+- **Script Execution**: Execute arbitrary C# scripts within the Unity Editor
+- **Log Management**: Access and filter Unity console logs
+- **GameObject Hierarchy**: List and filter GameObjects in the scene hierarchy
+- **Task Creation**: Create new Coplay tasks directly from MCP clients
+- **Parameter Validation**: Automatic parameter validation and type conversion based on tool schemas
+- **Version Compatibility**: Tools are locked to specific schema versions, ensuring compatibility with Unity plugin versions
+
+## Usage
+
+### As an MCP server
+
+Add to your MCP client configuration:
+
+```json
+{
+  "mcpServers": {
+    "coplay-mcp": {
+      "autoApprove": [],
+      "disabled": false,
+      "timeout": 60,
+      "type": "stdio",
+      "command": "uvx",
+      "args": [
+        "coplay-mcp-server@latest"
+      ]
+    }
+  }
+}
+```
+
+

coplay_mcp_server-1.4.1/TOOL_GENERATION.md

@@ -0,0 +1,170 @@
+# MCP Tool Code Generation
+
+This document explains the automated code generation system for MCP tools from JSON schema files.
+
+## Overview
+
+The Coplay MCP Server uses an automated code generation approach to expose tool functions with proper parameter descriptions. Instead of manually defining each tool, we generate Python functions from JSON schema files located in the Backend project.
+
+## How It Works
+
+1. **Schema Source**: Tool schemas are read from `Backend/coplay/tool_schemas/` directory
+2. **Code Generation**: The `code_generator.py` script processes these schemas and generates Python files
+3. **Parameter Descriptions**: Each parameter gets proper `Annotated` type hints with descriptions from the schema
+4. **MCP Registration**: Generated functions are automatically registered with the MCP server
+
+## Generated Files
+
+Generated files are located in `coplay_mcp_server/generated_tools/` and include:
+
+- `unity_functions_tools.py` - Unity Editor manipulation tools (34 tools)
+- `image_tool_tools.py` - Image generation and editing tools (1 tool)
+- `coplay_tool_tools.py` - Coplay-specific tools (1 tool)
+- `agent_tool_tools.py` - Agent management tools (6 tools)
+- `package_tool_tools.py` - Unity package management (7 tools)
+- `input_action_tool_tools.py` - Unity Input System tools (13 tools)
+- `ui_functions_tools.py` - Unity UI tools (6 tools)
+- `snapping_functions_tools.py` - Object snapping tools (4 tools)
+- `scene_view_functions_tools.py` - Scene view controls (1 tool)
+- `profiler_functions_tools.py` - Unity Profiler tools (2 tools)
+- `screenshot_tool_tools.py` - Screenshot capture tools (2 tools)
+
+**Total: 85 tools generated**
+
+## Automatic Code Generation
+
+### Pre-Build Hook
+
+Code generation runs automatically during the build process via a Hatchling build hook:
+
+```bash
+# When building the package, tools are automatically generated
+uv build
+```
+
+### Manual Generation
+
+You can also run code generation manually:
+
+```bash
+# Using the script command
+uv run coplay-generate-tools
+
+# Or directly
+uv run python -m coplay_mcp_server.code_generator
+```
+
+## Generated Code Structure
+
+Each generated tool function follows this pattern:
+
+```python
+async def create_gameobject(
+    name: Annotated[str, """The name of the new GameObject."""],
+    primitive_type: Annotated[Optional[str], """Optional. Type of primitive to create."""] = None,
+    position: Annotated[str, """Comma-separated position coordinates (e.g., 'x,y,z')."""],
+    # ... more parameters
+) -> Any:
+    """Creates a new GameObject in the Unity scene."""
+    try:
+        # Parameter validation and Unity RPC call
+        params = {}
+        if name is not None:
+            params['name'] = str(name)
+        # ... prepare other parameters
+        
+        result = await _unity_client.execute_request('create_gameobject', params)
+        return result
+    except Exception as e:
+        raise RuntimeError(f"Tool execution failed for create_gameobject: {e}")
+```
+
+## Key Features
+
+### Parameter Descriptions
+- Each parameter uses `Annotated[Type, """description"""]` for rich type information
+- Descriptions come directly from the JSON schema files
+- Required vs optional parameters are properly handled
+- Parameter ordering ensures required parameters come before optional ones
+
+### Error Handling
+- Comprehensive try/catch blocks for each tool
+- Detailed error messages with tool name and context
+- Graceful fallback if Unity client is unavailable
+
+### Logging
+- Debug logging for tool execution
+- Parameter logging for troubleshooting
+- Build-time logging for code generation process
+
+## Schema File Format
+
+The code generator expects JSON schema files in this format:
+
+```json
+[
+  {
+    "type": "function",
+    "function": {
+      "name": "create_gameobject",
+      "description": "Creates a new GameObject in the Unity scene.",
+      "parameters": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "The name of the new GameObject."
+          },
+          "position": {
+            "type": "string", 
+            "description": "Comma-separated position coordinates (e.g., 'x,y,z')."
+          }
+        },
+        "required": ["name", "position"]
+      }
+    }
+  }
+]
+```
+
+## Adding New Tools
+
+To add new tools:
+
+1. **Update Schema**: Add your tool definition to the appropriate JSON schema file in `Backend/coplay/tool_schemas/`
+2. **Regenerate**: Run `uv run coplay-generate-tools` or build the package
+3. **Test**: The new tool will be automatically available in the MCP server
+
+## Configuration
+
+The code generator can be configured by modifying `coplay_mcp_server/code_generator.py`:
+
+- `SCHEMA_FILES`: List of schema files to process
+- `_find_backend_path()`: Logic for finding the Backend directory
+- Type mapping in `_get_python_type_annotation()`
+
+## Benefits
+
+1. **Single Source of Truth**: Schema files in Backend project define all tools
+2. **Rich Parameter Descriptions**: MCP clients can show detailed parameter help
+3. **Type Safety**: Proper Python type hints for better IDE support
+4. **Automatic Updates**: Tools stay in sync with schema changes
+5. **Build Integration**: No manual steps required for deployment
+6. **Maintainability**: Centralized tool definitions reduce duplication
+
+## Troubleshooting
+
+### Code Generation Fails
+- Check that Backend directory exists and contains `coplay/tool_schemas/`
+- Verify schema files are valid JSON
+- Check build logs for specific error messages
+
+### Missing Tools
+- Ensure the schema file is listed in `SCHEMA_FILES`
+- Verify the schema follows the expected format
+- Check that `register_tools()` is called in `server.py`
+
+### Parameter Issues
+- Verify parameter types in schema match expected Python types
+- Check required vs optional parameter definitions
+- Ensure parameter descriptions don't contain problematic characters

coplay_mcp_server-1.4.1/build_hooks.py

@@ -0,0 +1,39 @@
+"""Build hooks for Hatchling to run code generation before building."""
+
+import logging
+import sys
+from pathlib import Path
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CustomBuildHook(BuildHookInterface):
+    """Custom build hook to run code generation before building."""
+    
+    PLUGIN_NAME = 'custom'
+    
+    def initialize(self, version, build_data):
+        """Initialize build hook - run code generation before building."""
+        print("Running MCP tool code generation as pre-build step...")
+        
+        try:
+            # Import and run the code generator
+            sys.path.insert(0, str(Path(__file__).parent))
+            from coplay_mcp_server.code_generator import MCPToolCodeGenerator
+            
+            # Set up logging for the build process
+            logging.basicConfig(level=logging.INFO, format="[BUILD] %(message)s")
+            
+            # Run code generation
+            generator = MCPToolCodeGenerator()
+            generator.generate_all_tools()
+            
+            print("MCP tool code generation completed successfully!")
+            
+        except Exception as e:
+            print(f"Error during code generation: {e}")
+            # Don't fail the build if code generation fails, just warn
+            print("Warning: Code generation failed, using existing generated files if available")
+    
+    def finalize(self, version, build_data, artifact_path):
+        """Finalize build hook - cleanup if needed."""
+        pass

coplay_mcp_server-1.4.1/coplay_mcp_server/__init__.py

@@ -0,0 +1,3 @@
+"""Coplay MCP Server - Unity Editor integration via MCP protocol."""
+
+__version__ = "1.4.1"