coplay-mcp-server


Namecoplay-mcp-server JSON
Version 1.2.2 PyPI version JSON
download
home_pageNone
SummaryA Model Context Protocol (MCP) server for Coplay, providing Unity integration capabilities
upload_time2025-08-12 17:06:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT
keywords coplay mcp model-context-protocol unity unity-editor
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Coplay MCP Server

A Model Context Protocol (MCP) server for Coplay, providing Unity Editor integration capabilities through MCP tools.

## Features

- **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

## 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"
      ]
    }
  }
}
```

## Available Tools

- `set_unity_project_root` - Set the Unity project root path
- `list_unity_project_roots` - Discover all running Unity Editor instances
- `execute_script` - Execute C# scripts in Unity Editor
- `get_unity_logs` - Retrieve Unity console logs with filtering
- `get_unity_editor_state` - Get current Unity Editor state
- `list_game_objects_in_hierarchy` - List GameObjects with filtering options
- `create_coplay_task` - Create new Coplay tasks

## Development

To launch the server in development mode:

```bash
uv run mcp dev coplay_mcp_server/server.py
```

### Prerequisites

- Python 3.11+
- [uv](https://docs.astral.sh/uv/) package manager
- Unity Editor with Coplay plugin installed

### Project Structure

- `coplay_mcp_server/server.py` - Main MCP server implementation
- `coplay_mcp_server/unity_client.py` - Unity RPC client for communication
- `coplay_mcp_server/process_discovery.py` - Process discovery utilities
- `pyproject.toml` - Project configuration and dependencies

## License

MIT License - see LICENSE file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "coplay-mcp-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "Coplay Dev <dev@coplay.com>",
    "keywords": "coplay, mcp, model-context-protocol, unity, unity-editor",
    "author": null,
    "author_email": "Coplay Dev <dev@coplay.com>",
    "download_url": "https://files.pythonhosted.org/packages/dc/2a/1cee13ae0e547a21223336d9a076b7d7a94127de76311d643c09ea334652/coplay_mcp_server-1.2.2.tar.gz",
    "platform": null,
    "description": "# Coplay MCP Server\n\nA Model Context Protocol (MCP) server for Coplay, providing Unity Editor integration capabilities through MCP tools.\n\n## Features\n\n- **Unity Project Discovery**: Automatically discover running Unity Editor instances and their project roots\n- **Unity Editor State**: Retrieve current Unity Editor state and scene hierarchy information\n- **Script Execution**: Execute arbitrary C# scripts within the Unity Editor\n- **Log Management**: Access and filter Unity console logs\n- **GameObject Hierarchy**: List and filter GameObjects in the scene hierarchy\n- **Task Creation**: Create new Coplay tasks directly from MCP clients\n\n## Usage\n\n### As an MCP server\n\nAdd to your MCP client configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"coplay-mcp\": {\n      \"autoApprove\": [],\n      \"disabled\": false,\n      \"timeout\": 60,\n      \"type\": \"stdio\",\n      \"command\": \"uvx\",\n      \"args\": [\n        \"coplay-mcp-server@latest\"\n      ]\n    }\n  }\n}\n```\n\n## Available Tools\n\n- `set_unity_project_root` - Set the Unity project root path\n- `list_unity_project_roots` - Discover all running Unity Editor instances\n- `execute_script` - Execute C# scripts in Unity Editor\n- `get_unity_logs` - Retrieve Unity console logs with filtering\n- `get_unity_editor_state` - Get current Unity Editor state\n- `list_game_objects_in_hierarchy` - List GameObjects with filtering options\n- `create_coplay_task` - Create new Coplay tasks\n\n## Development\n\nTo launch the server in development mode:\n\n```bash\nuv run mcp dev coplay_mcp_server/server.py\n```\n\n### Prerequisites\n\n- Python 3.11+\n- [uv](https://docs.astral.sh/uv/) package manager\n- Unity Editor with Coplay plugin installed\n\n### Project Structure\n\n- `coplay_mcp_server/server.py` - Main MCP server implementation\n- `coplay_mcp_server/unity_client.py` - Unity RPC client for communication\n- `coplay_mcp_server/process_discovery.py` - Process discovery utilities\n- `pyproject.toml` - Project configuration and dependencies\n\n## License\n\nMIT License - see LICENSE file for details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Model Context Protocol (MCP) server for Coplay, providing Unity integration capabilities",
    "version": "1.2.2",
    "project_urls": {
        "Documentation": "https://docs.coplay.dev/",
        "Homepage": "https://coplay.dev/",
        "Issues": "https://github.com/CoplayDev/coplay-unity-plugin/issues",
        "Repository": "https://github.com/CoplayDev/coplay-unity-plugin"
    },
    "split_keywords": [
        "coplay",
        " mcp",
        " model-context-protocol",
        " unity",
        " unity-editor"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "df240db24f9026051f3bbdfa9c1fc9fdcbd39ffd89f812750a318e50c12298aa",
                "md5": "9feb9297ea6311d553ddf3c9c846288b",
                "sha256": "7f8341efe563436a7fad6651a094572cd1ce6e4e1004b7c05d177969642cf37d"
            },
            "downloads": -1,
            "filename": "coplay_mcp_server-1.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9feb9297ea6311d553ddf3c9c846288b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 10254,
            "upload_time": "2025-08-12T17:06:35",
            "upload_time_iso_8601": "2025-08-12T17:06:35.930498Z",
            "url": "https://files.pythonhosted.org/packages/df/24/0db24f9026051f3bbdfa9c1fc9fdcbd39ffd89f812750a318e50c12298aa/coplay_mcp_server-1.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "dc2a1cee13ae0e547a21223336d9a076b7d7a94127de76311d643c09ea334652",
                "md5": "8a2e74ff6b8fdf8cffab7e939f3eb461",
                "sha256": "d99e71ea14ca455237c9b53b8413c647ecc2194d338ea3116b9de4bf57b58f5a"
            },
            "downloads": -1,
            "filename": "coplay_mcp_server-1.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8a2e74ff6b8fdf8cffab7e939f3eb461",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 39657,
            "upload_time": "2025-08-12T17:06:37",
            "upload_time_iso_8601": "2025-08-12T17:06:37.738538Z",
            "url": "https://files.pythonhosted.org/packages/dc/2a/1cee13ae0e547a21223336d9a076b7d7a94127de76311d643c09ea334652/coplay_mcp_server-1.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-12 17:06:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CoplayDev",
    "github_project": "coplay-unity-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "coplay-mcp-server"
}
        
Elapsed time: 1.40069s