PHXH
/
unity-mcp
51
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add GetAvailableCommands functionality to EditorControlHandler and Python tool 

- Implemented GetAvailableCommands method in EditorControlHandler.cs to retrieve available editor commands.
- Added corresponding get_available_commands tool in editor_tools.py to interface with the new command.
- Improved code formatting and readability throughout both files.
main
Kirill Kuvaldin 2025-03-19 14:12:58 -07:00
parent f200fcb67d
commit 0619ba7b05
2 changed files with 318 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

379
Editor/Commands/EditorControlHandler.cs
View File

@ -5,7 +5,7 @@ using Newtonsoft.Json.Linq;
using System; using System;
using System.Reflection; using System.Reflection;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; // Add LINQ namespace for Select extension method using System.Linq; // Add LINQ namespace for Select extension method
using System.Globalization; using System.Globalization;
/// <summary> /// <summary>
@ -39,6 +39,8 @@ public static class EditorControlHandler
return HandleExecuteCommand(commandParams); return HandleExecuteCommand(commandParams);
case "READ_CONSOLE": case "READ_CONSOLE":
return ReadConsole(commandParams); return ReadConsole(commandParams);
case "GET_AVAILABLE_COMMANDS":
return GetAvailableCommands();
default: default:
return new { error = $"Unknown editor control command: {command}" }; return new { error = $"Unknown editor control command: {command}" };
} }
@ -105,11 +107,7 @@ public static class EditorControlHandler
buildPlayerOptions.locationPathName = buildPath; buildPlayerOptions.locationPathName = buildPath;
BuildReport report = BuildPipeline.BuildPlayer(buildPlayerOptions); BuildReport report = BuildPipeline.BuildPlayer(buildPlayerOptions);
return new return new { message = "Build completed successfully", summary = report.summary };
{
message = "Build completed successfully",
summary = report.summary
};
} }
catch (System.Exception e) catch (System.Exception e)
{ {
@ -147,10 +145,14 @@ public static class EditorControlHandler
// Get filter parameters if provided // Get filter parameters if provided
if (@params != null) if (@params != null)
{ {
if (@params["show_logs"] != null) showLogs = (bool)@params["show_logs"]; if (@params["show_logs"] != null)
if (@params["show_warnings"] != null) showWarnings = (bool)@params["show_warnings"]; showLogs = (bool)@params["show_logs"];
if (@params["show_errors"] != null) showErrors = (bool)@params["show_errors"]; if (@params["show_warnings"] != null)
if (@params["search_term"] != null) searchTerm = (string)@params["search_term"]; showWarnings = (bool)@params["show_warnings"];
if (@params["show_errors"] != null)
showErrors = (bool)@params["show_errors"];
if (@params["search_term"] != null)
searchTerm = (string)@params["search_term"];
} }
try try
@ -160,20 +162,50 @@ public static class EditorControlHandler
Type logEntryType = Type.GetType("UnityEditor.LogEntry,UnityEditor"); Type logEntryType = Type.GetType("UnityEditor.LogEntry,UnityEditor");
if (logEntriesType == null || logEntryType == null) if (logEntriesType == null || logEntryType == null)
return new { error = "Could not find required Unity logging types", entries = new List<object>() }; return new
{
error = "Could not find required Unity logging types",
entries = new List<object>()
};
// Get essential methods // Get essential methods
MethodInfo getCountMethod = logEntriesType.GetMethod("GetCount", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic); MethodInfo getCountMethod = logEntriesType.GetMethod(
MethodInfo getEntryMethod = logEntriesType.GetMethod("GetEntryAt", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic) ?? "GetCount",
logEntriesType.GetMethod("GetEntryInternal", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic); BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic
);
MethodInfo getEntryMethod =
logEntriesType.GetMethod(
"GetEntryAt",
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic
)
?? logEntriesType.GetMethod(
"GetEntryInternal",
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic
);
if (getCountMethod == null || getEntryMethod == null) if (getCountMethod == null || getEntryMethod == null)
return new { error = "Could not find required Unity logging methods", entries = new List<object>() }; return new
{
error = "Could not find required Unity logging methods",
entries = new List<object>()
};
// Get stack trace method if available // Get stack trace method if available
MethodInfo getStackTraceMethod = logEntriesType.GetMethod("GetEntryStackTrace", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic, MethodInfo getStackTraceMethod =
null, new[] { typeof(int) }, null) ?? logEntriesType.GetMethod("GetStackTrace", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic, logEntriesType.GetMethod(
null, new[] { typeof(int) }, null); "GetEntryStackTrace",
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic,
null,
new[] { typeof(int) },
null
)
?? logEntriesType.GetMethod(
"GetStackTrace",
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic,
null,
new[] { typeof(int) },
null
);
// Get entry count and prepare result list // Get entry count and prepare result list
int count = (int)getCountMethod.Invoke(null, null); int count = (int)getCountMethod.Invoke(null, null);
@ -183,12 +215,17 @@ public static class EditorControlHandler
object logEntryInstance = Activator.CreateInstance(logEntryType); object logEntryInstance = Activator.CreateInstance(logEntryType);
// Find properties on LogEntry type // Find properties on LogEntry type
PropertyInfo modeProperty = logEntryType.GetProperty("mode") ?? logEntryType.GetProperty("Mode"); PropertyInfo modeProperty =
PropertyInfo messageProperty = logEntryType.GetProperty("message") ?? logEntryType.GetProperty("Message"); logEntryType.GetProperty("mode") ?? logEntryType.GetProperty("Mode");
PropertyInfo messageProperty =
logEntryType.GetProperty("message") ?? logEntryType.GetProperty("Message");
// Parse search terms if provided // Parse search terms if provided
string[] searchWords = !string.IsNullOrWhiteSpace(searchTerm) ? string[] searchWords = !string.IsNullOrWhiteSpace(searchTerm)
searchTerm.ToLower().Split(new char[] { ' ' }, StringSplitOptions.RemoveEmptyEntries) : null; ? searchTerm
.ToLower()
.Split(new char[] { ' ' }, StringSplitOptions.RemoveEmptyEntries)
: null;
// Process each log entry // Process each log entry
for (int i = 0; i < count; i++) for (int i = 0; i < count; i++)
@ -201,30 +238,41 @@ public static class EditorControlHandler
{ {
getEntryMethod.Invoke(null, new object[] { i, logEntryInstance }); getEntryMethod.Invoke(null, new object[] { i, logEntryInstance });
} }
else if (methodParams.Length >= 1 && methodParams[0].ParameterType == typeof(int)) else if (
methodParams.Length >= 1 && methodParams[0].ParameterType == typeof(int)
)
{ {
var parameters = new object[methodParams.Length]; var parameters = new object[methodParams.Length];
parameters[0] = i; parameters[0] = i;
for (int p = 1; p < parameters.Length; p++) for (int p = 1; p < parameters.Length; p++)
{ {
parameters[p] = methodParams[p].ParameterType.IsValueType ? parameters[p] = methodParams[p].ParameterType.IsValueType
Activator.CreateInstance(methodParams[p].ParameterType) : null; ? Activator.CreateInstance(methodParams[p].ParameterType)
: null;
} }
getEntryMethod.Invoke(null, parameters); getEntryMethod.Invoke(null, parameters);
} }
else continue; else
continue;
// Extract log data // Extract log data
int logType = modeProperty != null ? int logType =
Convert.ToInt32(modeProperty.GetValue(logEntryInstance) ?? 0) : 0; modeProperty != null
? Convert.ToInt32(modeProperty.GetValue(logEntryInstance) ?? 0)
: 0;
string message = messageProperty != null ? string message =
(messageProperty.GetValue(logEntryInstance)?.ToString() ?? "") : ""; messageProperty != null
? (messageProperty.GetValue(logEntryInstance)?.ToString() ?? "")
: "";
// If message is empty, try to get it via a field // If message is empty, try to get it via a field
if (string.IsNullOrEmpty(message)) if (string.IsNullOrEmpty(message))
{ {
var msgField = logEntryType.GetField("message", BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); var msgField = logEntryType.GetField(
"message",
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance
);
if (msgField != null) if (msgField != null)
{ {
object msgValue = msgField.GetValue(logEntryInstance); object msgValue = msgField.GetValue(logEntryInstance);
@ -235,50 +283,93 @@ public static class EditorControlHandler
if (string.IsNullOrEmpty(message)) if (string.IsNullOrEmpty(message))
{ {
// Access ConsoleWindow and its data // Access ConsoleWindow and its data
Type consoleWindowType = Type.GetType("UnityEditor.ConsoleWindow,UnityEditor"); Type consoleWindowType = Type.GetType(
"UnityEditor.ConsoleWindow,UnityEditor"
);
if (consoleWindowType != null) if (consoleWindowType != null)
{ {
try try
{ {
// Get Console window instance // Get Console window instance
var getWindowMethod = consoleWindowType.GetMethod("GetWindow", var getWindowMethod =
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic, consoleWindowType.GetMethod(
null, new[] { typeof(bool) }, null) ?? "GetWindow",
consoleWindowType.GetMethod("GetConsoleWindow", BindingFlags.Static
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic); | BindingFlags.Public
| BindingFlags.NonPublic,
null,
new[] { typeof(bool) },
null
)
?? consoleWindowType.GetMethod(
"GetConsoleWindow",
BindingFlags.Static
| BindingFlags.Public
| BindingFlags.NonPublic
);
if (getWindowMethod != null) if (getWindowMethod != null)
{ {
object consoleWindow = getWindowMethod.Invoke(null, object consoleWindow = getWindowMethod.Invoke(
getWindowMethod.GetParameters().Length > 0 ? new object[] { false } : null); null,
getWindowMethod.GetParameters().Length > 0
? new object[] { false }
: null
);
if (consoleWindow != null) if (consoleWindow != null)
{ {
// Try to find log entries collection // Try to find log entries collection
foreach (var prop in consoleWindowType.GetProperties(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic)) foreach (
var prop in consoleWindowType.GetProperties(
BindingFlags.Instance
| BindingFlags.Public
| BindingFlags.NonPublic
)
)
{ {
if (prop.PropertyType.IsArray || if (
(prop.PropertyType.IsGenericType && prop.PropertyType.GetGenericTypeDefinition() == typeof(List<>))) prop.PropertyType.IsArray
|| (
prop.PropertyType.IsGenericType
&& prop.PropertyType.GetGenericTypeDefinition()
== typeof(List<>)
)
)
{ {
try try
{ {
var logItems = prop.GetValue(consoleWindow); var logItems = prop.GetValue(consoleWindow);
if (logItems != null) if (logItems != null)
{ {
if (logItems.GetType().IsArray && i < ((Array)logItems).Length) if (
logItems.GetType().IsArray
&& i < ((Array)logItems).Length
)
{ {
var entry = ((Array)logItems).GetValue(i); var entry = (
(Array)logItems
).GetValue(i);
if (entry != null) if (entry != null)
{ {
var entryType = entry.GetType(); var entryType = entry.GetType();
var entryMessageProp = entryType.GetProperty("message") ?? var entryMessageProp =
entryType.GetProperty("Message"); entryType.GetProperty(
"message"
)
?? entryType.GetProperty(
"Message"
);
if (entryMessageProp != null) if (entryMessageProp != null)
{ {
object value = entryMessageProp.GetValue(entry); object value =
entryMessageProp.GetValue(
entry
);
if (value != null) if (value != null)
{ {
message = value.ToString(); message =
value.ToString();
break; break;
} }
} }
@ -314,23 +405,42 @@ public static class EditorControlHandler
if (Application.platform == RuntimePlatform.WindowsEditor) if (Application.platform == RuntimePlatform.WindowsEditor)
{ {
logPath = System.IO.Path.Combine( logPath = System.IO.Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), Environment.GetFolderPath(
"Unity", "Editor", "Editor.log"); Environment.SpecialFolder.LocalApplicationData
),
"Unity",
"Editor",
"Editor.log"
);
} }
else if (Application.platform == RuntimePlatform.OSXEditor) else if (Application.platform == RuntimePlatform.OSXEditor)
{ {
logPath = System.IO.Path.Combine( logPath = System.IO.Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.Personal), Environment.GetFolderPath(
"Library", "Logs", "Unity", "Editor.log"); Environment.SpecialFolder.Personal
),
"Library",
"Logs",
"Unity",
"Editor.log"
);
} }
else if (Application.platform == RuntimePlatform.LinuxEditor) else if (Application.platform == RuntimePlatform.LinuxEditor)
{ {
logPath = System.IO.Path.Combine( logPath = System.IO.Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.Personal), Environment.GetFolderPath(
".config", "unity3d", "logs", "Editor.log"); Environment.SpecialFolder.Personal
),
".config",
"unity3d",
"logs",
"Editor.log"
);
} }
if (!string.IsNullOrEmpty(logPath) && System.IO.File.Exists(logPath)) if (
!string.IsNullOrEmpty(logPath) && System.IO.File.Exists(logPath)
)
{ {
// Read last few lines from the log file // Read last few lines from the log file
var logLines = ReadLastLines(logPath, 100); var logLines = ReadLastLines(logPath, 100);
@ -351,14 +461,17 @@ public static class EditorControlHandler
string stackTrace = ""; string stackTrace = "";
if (getStackTraceMethod != null) if (getStackTraceMethod != null)
{ {
stackTrace = getStackTraceMethod.Invoke(null, new object[] { i })?.ToString() ?? ""; stackTrace =
getStackTraceMethod.Invoke(null, new object[] { i })?.ToString() ?? "";
} }
// Filter by type // Filter by type
bool typeMatch = (logType == 0 && showLogs) || bool typeMatch =
(logType == 1 && showWarnings) || (logType == 0 && showLogs)
(logType == 2 && showErrors); || (logType == 1 && showWarnings)
if (!typeMatch) continue; || (logType == 2 && showErrors);
if (!typeMatch)
continue;
// Filter by search term // Filter by search term
bool searchMatch = true; bool searchMatch = true;
@ -376,16 +489,24 @@ public static class EditorControlHandler
} }
} }
} }
if (!searchMatch) continue; if (!searchMatch)
continue;
// Add matching entry to results // Add matching entry to results
string typeStr = logType == 0 ? "Log" : logType == 1 ? "Warning" : "Error"; string typeStr =
entries.Add(new logType == 0
{ ? "Log"
type = typeStr, : logType == 1
message = message, ? "Warning"
stackTrace = stackTrace : "Error";
}); entries.Add(
new
{
type = typeStr,
message = message,
stackTrace = stackTrace
}
);
} }
catch (Exception) catch (Exception)
{ {
@ -420,8 +541,10 @@ public static class EditorControlHandler
{ {
foreach (var methodName in methodNames) foreach (var methodName in methodNames)
{ {
var method = type.GetMethod(methodName, var method = type.GetMethod(
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic); methodName,
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic
);
if (method != null) if (method != null)
return method; return method;
} }
@ -433,13 +556,27 @@ public static class EditorControlHandler
BuildTarget target; BuildTarget target;
switch (platform.ToLower()) switch (platform.ToLower())
{ {
case "windows": target = BuildTarget.StandaloneWindows64; break; case "windows":
case "mac": target = BuildTarget.StandaloneOSX; break; target = BuildTarget.StandaloneWindows64;
case "linux": target = BuildTarget.StandaloneLinux64; break; break;
case "android": target = BuildTarget.Android; break; case "mac":
case "ios": target = BuildTarget.iOS; break; target = BuildTarget.StandaloneOSX;
case "webgl": target = BuildTarget.WebGL; break; break;
default: target = (BuildTarget)(-1); break; // Invalid target case "linux":
target = BuildTarget.StandaloneLinux64;
break;
case "android":
target = BuildTarget.Android;
break;
case "ios":
target = BuildTarget.iOS;
break;
case "webgl":
target = BuildTarget.WebGL;
break;
default:
target = (BuildTarget)(-1);
break; // Invalid target
} }
return target; return target;
} }
@ -465,8 +602,12 @@ public static class EditorControlHandler
var result = new Dictionary<string, object>(); var result = new Dictionary<string, object>();
// Get all public and non-public properties // Get all public and non-public properties
var properties = type.GetProperties(BindingFlags.Public | BindingFlags.NonPublic | var properties = type.GetProperties(
BindingFlags.Static | BindingFlags.Instance); BindingFlags.Public
| BindingFlags.NonPublic
| BindingFlags.Static
| BindingFlags.Instance
);
var propList = new List<string>(); var propList = new List<string>();
foreach (var prop in properties) foreach (var prop in properties)
{ {
@ -475,8 +616,12 @@ public static class EditorControlHandler
result["Properties"] = propList; result["Properties"] = propList;
// Get all public and non-public fields // Get all public and non-public fields
var fields = type.GetFields(BindingFlags.Public | BindingFlags.NonPublic | var fields = type.GetFields(
BindingFlags.Static | BindingFlags.Instance); BindingFlags.Public
| BindingFlags.NonPublic
| BindingFlags.Static
| BindingFlags.Instance
);
var fieldList = new List<string>(); var fieldList = new List<string>();
foreach (var field in fields) foreach (var field in fields)
{ {
@ -485,15 +630,21 @@ public static class EditorControlHandler
result["Fields"] = fieldList; result["Fields"] = fieldList;
// Get all public and non-public methods // Get all public and non-public methods
var methods = type.GetMethods(BindingFlags.Public | BindingFlags.NonPublic | var methods = type.GetMethods(
BindingFlags.Static | BindingFlags.Instance); BindingFlags.Public
| BindingFlags.NonPublic
| BindingFlags.Static
| BindingFlags.Instance
);
var methodList = new List<string>(); var methodList = new List<string>();
foreach (var method in methods) foreach (var method in methods)
{ {
if (!method.Name.StartsWith("get_") && !method.Name.StartsWith("set_")) if (!method.Name.StartsWith("get_") && !method.Name.StartsWith("set_"))
{ {
var parameters = string.Join(", ", method.GetParameters() var parameters = string.Join(
.Select(p => $"{p.ParameterType.Name} {p.Name}")); ", ",
method.GetParameters().Select(p => $"{p.ParameterType.Name} {p.Name}")
);
methodList.Add($"{method.ReturnType.Name} {method.Name}({parameters})"); methodList.Add($"{method.ReturnType.Name} {method.Name}({parameters})");
} }
} }
@ -507,13 +658,16 @@ public static class EditorControlHandler
/// </summary> /// </summary>
private static Dictionary<string, string> GetObjectValues(object obj) private static Dictionary<string, string> GetObjectValues(object obj)
{ {
if (obj == null) return new Dictionary<string, string>(); if (obj == null)
return new Dictionary<string, string>();
var result = new Dictionary<string, string>(); var result = new Dictionary<string, string>();
var type = obj.GetType(); var type = obj.GetType();
// Get all property values // Get all property values
var properties = type.GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); var properties = type.GetProperties(
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance
);
foreach (var prop in properties) foreach (var prop in properties)
{ {
try try
@ -528,7 +682,9 @@ public static class EditorControlHandler
} }
// Get all field values // Get all field values
var fields = type.GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); var fields = type.GetFields(
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance
);
foreach (var field in fields) foreach (var field in fields)
{ {
try try
@ -552,7 +708,14 @@ public static class EditorControlHandler
{ {
var result = new List<string>(); var result = new List<string>();
using (var stream = new System.IO.FileStream(filePath, System.IO.FileMode.Open, System.IO.FileAccess.Read, System.IO.FileShare.ReadWrite)) using (
var stream = new System.IO.FileStream(
filePath,
System.IO.FileMode.Open,
System.IO.FileAccess.Read,
System.IO.FileShare.ReadWrite
)
)
using (var reader = new System.IO.StreamReader(stream)) using (var reader = new System.IO.StreamReader(stream))
{ {
string line; string line;
@ -589,4 +752,42 @@ public static class EditorControlHandler
return result; return result;
} }
/// <summary>
/// Gets a list of available editor commands that can be executed
/// the method should have a MenuItem attribute
/// </summary>
/// <returns>Object containing list of available command paths</returns>
[MenuItem("Window/Get Available Commands")]
private static object GetAvailableCommands()
{
var commands = new List<string>();
Assembly assembly = Assembly.GetExecutingAssembly();
foreach (Type type in assembly.GetTypes())
{
MethodInfo[] methods = type.GetMethods(
BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic
);
foreach (MethodInfo method in methods)
{
// Look for the MenuItem attribute
object[] attributes = method.GetCustomAttributes(
typeof(UnityEditor.MenuItem),
false
);
if (attributes.Length > 0)
{
UnityEditor.MenuItem menuItem = attributes[0] as UnityEditor.MenuItem;
commands.Add(menuItem.menuItem);
}
}
}
Debug.Log($"commands.Count: {commands.Count}");
foreach (var command in commands)
{
Debug.Log($"Command: {command}");
}
return new { commands = commands };
}
} }

26
Python/tools/editor_tools.py
View File

@ -267,3 +267,29 @@ def register_editor_tools(mcp: FastMCP):
"message": f"Error reading console: {str(e)}", "message": f"Error reading console: {str(e)}",
"stackTrace": "" "stackTrace": ""
}] }]
@mcp.tool()
def get_available_commands(ctx: Context) -> List[str]:
"""Get a list of all available editor commands that can be executed.
This tool provides direct access to the list of commands that can be executed
in the Unity Editor through the MCP system.
Returns:
List[str]: List of available command paths
"""
try:
unity = get_unity_connection()
# Send request for available commands
response = unity.send_command("EDITOR_CONTROL", {
"command": "GET_AVAILABLE_COMMANDS"
})
# Extract commands list
commands = response.get("commands", [])
# Return the commands list
return commands
except Exception as e:
return [f"Error fetching commands: {str(e)}"]