4.2 KiB
4.2 KiB
name, description
| name | description |
|---|---|
| unity-tool-list | List all Unity-MCP tools registered in the connected Unity Editor instance. Optional regex filter matches against tool name, description, and argument names/descriptions. Use the `includeDescription` / `includeInputs` toggles to control the response size. |
Tool / List
List all Unity-MCP tools registered in the connected Unity Editor instance. Optionally filter by regex across tool names, descriptions, and arguments.
Inputs
regexSearch(optional) — case-insensitive regex with a 200ms execution-timeout guard. Invalid regex throws anArgumentException. Matches name → description → input names → input descriptions.includeDescription(defaultfalse) — populate each tool'sDescriptionfield.includeInputs(defaultNone) — one ofNone,Inputs(names only),InputsWithDescription(names + descriptions).
Behavior
Iterates UnityMcpPluginEditor.Instance.Tools.GetAllTools(), evaluates the filter (if any), and projects each surviving tool into a ToolInfoData honoring the verbosity toggles.
How to Call
unity-mcp-cli run-tool unity-tool-list --input '{
"regexSearch": "string_value",
"includeDescription": "string_value",
"includeInputs": "string_value"
}'
For complex input (multi-line strings, code), save the JSON to a file and use:
unity-mcp-cli run-tool unity-tool-list --input-file args.jsonOr pipe via stdin (recommended):
unity-mcp-cli run-tool unity-tool-list --input-file - <<'EOF' {"param": "value"} EOF
Troubleshooting
If unity-mcp-cli is not found, either install it globally (npm install -g unity-mcp-cli) or use npx unity-mcp-cli instead.
Read the /unity-initial-setup skill for detailed installation instructions.
Input
| Name | Type | Required | Description |
|---|---|---|---|
regexSearch |
string |
No | Regex pattern to filter tools. Matches against tool name, description, and argument names and descriptions. |
includeDescription |
any |
No | Include tool descriptions in the result. Default: false |
includeInputs |
any |
No | Include input arguments in the result. Default: None |
Input JSON Schema
{
"type": "object",
"properties": {
"regexSearch": {
"type": "string"
},
"includeDescription": {
"$ref": "#/$defs/System.Boolean"
},
"includeInputs": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Editor.API.Tool_Tool-InputRequest"
}
},
"$defs": {
"System.Boolean": {
"type": "boolean"
},
"com.IvanMurzak.Unity.MCP.Editor.API.Tool_Tool-InputRequest": {
"type": "string",
"enum": [
"None",
"Inputs",
"InputsWithDescription"
],
"description": "Specifies what to include for tool input arguments."
}
}
}
Output
Output JSON Schema
{
"type": "object",
"properties": {
"result": {
"$ref": "#/$defs/AIGD.ToolInfoData-1"
}
},
"$defs": {
"AIGD.ToolInfoData": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Tool name."
},
"description": {
"type": "string",
"description": "Tool description."
},
"inputs": {
"$ref": "#/$defs/AIGD.ToolInputData-1",
"description": "Tool input arguments."
}
},
"description": "MCP tool information."
},
"AIGD.ToolInputData-1": {
"type": "array",
"items": {
"$ref": "#/$defs/AIGD.ToolInputData",
"description": "MCP tool input argument."
}
},
"AIGD.ToolInputData": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Argument name."
},
"description": {
"type": "string",
"description": "Argument description."
}
},
"description": "MCP tool input argument."
},
"AIGD.ToolInfoData-1": {
"type": "array",
"items": {
"$ref": "#/$defs/AIGD.ToolInfoData",
"description": "MCP tool information."
}
}
},
"required": [
"result"
]
}