6.8 KiB
6.8 KiB
| name | description | metadata | ||
|---|---|---|---|---|
| navigation-surface-bake | Bake (build) the NavMesh for a `NavMeshSurface`, or clear its existing baked data. Pass `clear = true` to remove the baked NavMeshData instead of building it. |
|
Navigation / Bake or Clear NavMeshSurface
Build or clear the runtime NavMesh for a NavMeshSurface.
Inputs
gameObjectRef— the GameObject hosting theNavMeshSurface(required).clear— whentrue, removes the surface's baked NavMeshData (RemoveData) instead of baking. Defaultfalse(bake viaBuildNavMesh).
Behavior
When baking, collects the surface's geometry sources and builds the NavMeshData, then marks the surface dirty so the result is saved. When clearing, removes the active NavMeshData from the surface. Marks the scene dirty and repaints. Runs on the Unity main thread.
How to Call
unity-mcp-cli run-tool navigation-surface-bake --input '{
"gameObjectRef": "string_value",
"clear": false
}'
For complex input (multi-line strings, code), save the JSON to a file and use:
unity-mcp-cli run-tool navigation-surface-bake --input-file args.jsonOr pipe via stdin (recommended):
unity-mcp-cli run-tool navigation-surface-bake --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 |
|---|---|---|---|
gameObjectRef |
any |
Yes | Reference to the GameObject containing the NavMeshSurface component. |
clear |
boolean |
No | If true, clears the baked NavMeshData instead of baking it. |
Input JSON Schema
{
"type": "object",
"properties": {
"gameObjectRef": {
"$ref": "#/$defs/AIGD.GameObjectRef"
},
"clear": {
"type": "boolean"
}
},
"$defs": {
"UnityEngine.EntityId": {
"type": "string",
"pattern": "^[0-9]+$"
},
"System.Type": {
"type": "string"
},
"AIGD.GameObjectRef": {
"type": "object",
"properties": {
"instanceID": {
"$ref": "#/$defs/UnityEngine.EntityId",
"description": "instanceID of the UnityEngine.Object. If it is '0' and 'path', 'name', 'assetPath' and 'assetGuid' is not provided, empty or null, then it will be used as 'null'. Priority: 1 (Recommended)"
},
"path": {
"type": "string",
"description": "Path of a GameObject in the hierarchy Sample 'character/hand/finger/particle'. Priority: 2."
},
"name": {
"type": "string",
"description": "Name of a GameObject in hierarchy. Priority: 3."
},
"assetType": {
"$ref": "#/$defs/System.Type",
"description": "Type of the asset."
},
"assetPath": {
"type": "string",
"description": "Path to the asset within the project. Starts with 'Assets/'"
},
"assetGuid": {
"type": "string",
"description": "Unique identifier for the asset."
}
},
"required": [
"instanceID"
],
"description": "Find GameObject in opened Prefab or in the active Scene."
}
},
"required": [
"gameObjectRef"
]
}
Output
Output JSON Schema
{
"type": "object",
"properties": {
"result": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Editor.API.Tool_Navigation-SurfaceBakeResponse"
}
},
"$defs": {
"AIGD.GameObjectRef": {
"type": "object",
"properties": {
"instanceID": {
"$ref": "#/$defs/UnityEngine.EntityId",
"description": "instanceID of the UnityEngine.Object. If it is '0' and 'path', 'name', 'assetPath' and 'assetGuid' is not provided, empty or null, then it will be used as 'null'. Priority: 1 (Recommended)"
},
"path": {
"type": "string",
"description": "Path of a GameObject in the hierarchy Sample 'character/hand/finger/particle'. Priority: 2."
},
"name": {
"type": "string",
"description": "Name of a GameObject in hierarchy. Priority: 3."
},
"assetType": {
"$ref": "#/$defs/System.Type",
"description": "Type of the asset."
},
"assetPath": {
"type": "string",
"description": "Path to the asset within the project. Starts with 'Assets/'"
},
"assetGuid": {
"type": "string",
"description": "Unique identifier for the asset."
}
},
"required": [
"instanceID"
],
"description": "Find GameObject in opened Prefab or in the active Scene."
},
"UnityEngine.EntityId": {
"type": "string",
"pattern": "^[0-9]+$"
},
"System.Type": {
"type": "string"
},
"AIGD.ComponentRef": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"description": "Component 'index' attached to a gameObject. The first index is '0' and that is usually Transform or RectTransform. Priority: 2. Default value is -1."
},
"typeName": {
"type": "string",
"description": "Component type full name. Sample 'UnityEngine.Transform'. If the gameObject has two components of the same type, the output component is unpredictable. Priority: 3. Default value is null."
},
"instanceID": {
"$ref": "#/$defs/UnityEngine.EntityId",
"description": "instanceID of the UnityEngine.Object. If this is '0', then it will be used as 'null'."
}
},
"required": [
"index",
"instanceID"
],
"description": "Component reference. Used to find a Component at GameObject."
},
"com.IvanMurzak.Unity.MCP.Editor.API.Tool_Navigation-SurfaceBakeResponse": {
"type": "object",
"properties": {
"gameObjectRef": {
"$ref": "#/$defs/AIGD.GameObjectRef",
"description": "Reference to the NavMeshSurface GameObject."
},
"surfaceRef": {
"$ref": "#/$defs/AIGD.ComponentRef",
"description": "Reference to the NavMeshSurface component."
},
"cleared": {
"type": "boolean",
"description": "Whether the surface was cleared (true) or baked (false)."
},
"hasNavMeshData": {
"type": "boolean",
"description": "Whether the surface has baked NavMeshData after the operation."
},
"success": {
"type": "boolean",
"description": "Whether the operation succeeded."
}
},
"required": [
"cleared",
"hasNavMeshData",
"success"
]
}
},
"required": [
"result"
]
}