Mayamcp

🚀 Maya MCP Server Implementation Guide

This guide details how to implement an MCP-based server in Maya and integrate it with AI assistants like Claude Desktop.

🚀 Quick Start

MCP (Model Context Protocol) is a standard protocol for connecting different tools and services. This document elaborates on implementing an MCP-based server in Maya and integrating it with AI assistants such as Claude Desktop.

📦 Installation

System Requirements

• Operating System: Supports Windows, Linux, and MacOS.
• Python Version: Requires Python 3.6 or higher.
• Maya Version: Compatible with Maya 2018 and later.

Installation Steps

1. Download and install Python if it's not already installed.
2. Install the MCP Python SDK using the following command:

   python -m pip install mcp-sdk
   

3. Add Maya's script path to PYTHONPATH, for example:

   export PYTHONPATH="${PYTHONPATH}:/path/to/maya/scripts"
   

📚 Configuration

Server Startup

After installation, start the MCP server with the following command:

python -m mcp_server.start --config /path/to/config.json

The configuration file config.json should contain the following:

{
  "port": 4000,
  "tools": ["tool1", "tool2"],
  "logging": {
    "level": "INFO",
    "file": "/var/log/mcp.log"
  }
}

Tool Registration

All tools must be placed in the mayatools/thirdparty directory, and the file name should match the function name. For example, create a new tool mymayafunction.py:

def my_maya_function(arg1: str, arg2: int) -> dict:
    """
    Example Maya tool function.
    
    Args:
        arg1: String parameter
        arg2: Integer parameter
        
    Returns:
        Dictionary result
    """
    # Implementation logic
    pass

💻 Tool List

The following are the currently implemented tools and their functions:

🔧 Developer Notes

Adding New Tools

1. File Naming: The tool file name must match the function name, e.g., createssphere.py.
2. Function Signature: Define function parameters and return values using type annotations.
3. Scope Limitation: Tools will run within the _mcp_maya_scope() function to avoid global variable pollution.
4. Error Handling: Add appropriate error checks in tools and throw exceptions for easy catching.

Example Code

def create_sphere(radius: float = 1.0) -> str:
    """
    Create a new Maya sphere.
    
    Args:
        radius: Sphere radius
        
    Returns:
        Name of the newly created node
    """
    sphere = cmds.sphere(r=radius)
    return sphere[0]

🧪 Testing and Validation

• Unit Testing: Write test cases for each tool using the pytest framework.
• Integration Testing: Test the functionality and performance of tools in an actual Maya scene.

🚧 Future Improvements

1. Expand more features, such as UV operations and animation control.
2. Improve Prompt Engineering to optimize the description of the relationship between the model and Maya data.
3. Automatically detect MCP tools in Maya plugins and register them with the server.

📄 License

This project is licensed under the MIT License, allowing free use and modification while retaining the copyright notice.

🔗 Linked Resources

• MCP Official Documentation
• Claude Desktop Download
• Python MCP SDK
• Unreal MCP Project

⚠️ Important Note

This implementation example is for demonstration purposes only. Please adjust the configuration and functionality according to your needs in actual applications.