Maya Setup Guide
maya_setup_guideDiagnose and repair Maya MCP connection problems, auto-install userSetup.py, and provide step-by-step setup guidance for first-time setup or empty session lists.
Instructions
Maya connection setup guide and diagnostics.
Boundary: Disambiguated from list_sessions (read the current session set) and add_session (attach a host:port you already know) — maya_setup_guide diagnoses and repairs the connection itself.
Use this tool when list_sessions returns empty or when setting up Maya MCP for the first time. Provides platform-aware diagnostics, auto-installation of userSetup.py, and step-by-step fallback instructions.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "maya_setup_guide"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | Maya command port number (default: 7001) | |
| action | No | What to do: - "diagnose": Run connection diagnostics and return status - "install": Merge the managed marker block into userSetup.py. Existing files without the block require a second call with confirm=True (the first call returns the proposed block). - "guide": Get full step-by-step connection guide - "uninstall": Remove the managed marker block from userSetup.py | diagnose |
| confirm | No | Required to write into an existing userSetup.py that has no mcp-for-maya marker block (first install call is dry-run). | |
| dry_run | No | Preview the install: return the proposed block without writing anything. | |
| target_version | No | Specific Maya version (e.g., "2024"). If None, targets all detected versions. | |
| remove_empty_file | No | On uninstall, delete the file when it only contained the marker block. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||