6.5 KiB
| name | description | metadata | ||
|---|---|---|---|---|
| tests-run | Execute Unity tests (`EditMode` or `PlayMode`) and return per-test results. Supports filtering by test assembly, namespace, class, and method. Refreshes the AssetDatabase first; defers execution across domain reloads if scripts changed. Precondition: every open scene must be saved — dirty scenes abort the run. |
|
Tests / Run
Execute Unity tests and return detailed results. Supports filtering by test mode, assembly, namespace, class, and method. Recommended to use 'EditMode' for faster iteration during development. Precondition: every open scene MUST be saved (no unsaved changes). If any open scene is dirty, this tool throws an InvalidOperationException listing the dirty scenes; save them and retry.
Filters
testMode(defaultEditMode) —EditModeorPlayMode. EditMode is faster; prefer it during iteration.testAssembly/testNamespace/testClass/testMethod— optional, layered filters. Namespace and class filters become regexgroupNamesso the validation count and Unity's execution stay in sync.testMethodmust be fully qualified (Namespace.FixtureName.TestName).query— RQL over thetestssource instead of the four filters: any selection, run as ONE Test Runner run, e.g.tests | where fixture == "PlayerTests" or categories contains "Smoke". One mode per run; the mode comes from the selected tests. Explore first with rql-query:tests | where fullName contains "Spline" | select fullName mode.result— RQL stages applied to the results (sourcetestResults: name status durationMs message stackTrace), e.g.where status == "Failed" | select name message; the answer is then a summary line plus compact RQL text.
Response toggles
includePassingTests(defaultfalse) — include details for passing tests; otherwise only failing test details are returned.includeMessages(defaulttrue) — include per-test result messages.includeStacktrace(defaultfalse) — include stack traces for failing tests.includeLogs(defaultfalse) — include console logs captured during the run.logType(defaultWarning) — minimum log severity to include.includeLogsStacktrace(defaultfalse) — include log stack traces (large payload; use sparingly).
Domain reloads
If the AssetDatabase refresh triggers compilation, the tool persists the run parameters to SessionState, returns Processing, and resumes the run automatically after the reload completes. Pre-existing compilation errors short-circuit the run and return the error details so the caller can fix the project first.
How to Call
unity-mcp-cli run-tool tests-run --input '{
"testMode": "string_value",
"testAssembly": "string_value",
"testNamespace": "string_value",
"testClass": "string_value",
"testMethod": "string_value",
"query": "string_value",
"result": "string_value",
"includePassingTests": false,
"includeMessages": false,
"includeStacktrace": false,
"includeLogs": false,
"logType": "string_value",
"includeLogsStacktrace": false
}'
For complex input (multi-line strings, code), save the JSON to a file and use:
unity-mcp-cli run-tool tests-run --input-file args.jsonOr pipe via stdin (recommended):
unity-mcp-cli run-tool tests-run --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 |
|---|---|---|---|
testMode |
string |
No | Test mode to run. Options: 'EditMode', 'PlayMode'. Default: 'EditMode' |
testAssembly |
string |
No | Specific test assembly name to run (optional). Example: 'Assembly-CSharp-Editor-testable' |
testNamespace |
string |
No | Specific test namespace to run (optional). Example: 'MyTestNamespace' |
testClass |
string |
No | Specific test class name to run (optional). Example: 'MyTestClass' |
testMethod |
string |
No | Specific fully qualified test method to run (optional). Example: 'MyTestNamespace.FixtureName.TestName' |
query |
string |
No | RQL over the 'tests' source selecting the tests (instead of the filters above), run as one run. Example: tests |
result |
string |
No | RQL stages applied to the results (source 'testResults': name status durationMs message stackTrace); the answer is a summary line plus compact text. Example: where status == "Failed" |
includePassingTests |
boolean |
No | Include details for all tests, both passing and failing (default: false). If you just need details for failing tests, set to false. |
includeMessages |
boolean |
No | Include test result messages in the test results (default: true). If you just need pass/fail status, set to false. |
includeStacktrace |
boolean |
No | Include stack traces in the test results (default: false). |
includeLogs |
boolean |
No | Include console logs in the test results (default: false). |
logType |
string |
No | Log type filter for console logs. Options: 'Log', 'Warning', 'Assert', 'Error', 'Exception'. (default: 'Warning') |
includeLogsStacktrace |
boolean |
No | Include stack traces for console logs in the test results (default: false). This is huge amount of data, use only if really needed. |
Input JSON Schema
{
"type": "object",
"properties": {
"testMode": {
"type": "string",
"enum": [
"EditMode",
"PlayMode"
]
},
"testAssembly": {
"type": "string"
},
"testNamespace": {
"type": "string"
},
"testClass": {
"type": "string"
},
"testMethod": {
"type": "string"
},
"query": {
"type": "string"
},
"result": {
"type": "string"
},
"includePassingTests": {
"type": "boolean"
},
"includeMessages": {
"type": "boolean"
},
"includeStacktrace": {
"type": "boolean"
},
"includeLogs": {
"type": "boolean"
},
"logType": {
"type": "string",
"enum": [
"Error",
"Assert",
"Warning",
"Log",
"Exception"
]
},
"includeLogsStacktrace": {
"type": "boolean"
}
}
}
Output
This tool does not return structured output.