Skip to content

Commit d1691a7

Browse files
committed
docs: improve tool descriptions with clearer action explanations
1 parent 8cd7fba commit d1691a7

File tree

9 files changed

+9
-9
lines changed

9 files changed

+9
-9
lines changed

UnityMcpBridge/UnityMcpServer~/src/tools/manage_asset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def register_manage_asset_tools(mcp: FastMCP):
1717
@telemetry_tool("manage_asset")
1818
async def manage_asset(
1919
ctx: Context,
20-
action: Annotated[Literal["import", "create", "modify", "delete", "duplicate", "move", "rename", "search", "get_info", "create_folder", "get_components"], "Operations"],
20+
action: Annotated[Literal["import", "create", "modify", "delete", "duplicate", "move", "rename", "search", "get_info", "create_folder", "get_components"], "Perform CRUD operations on assets."],
2121
path: Annotated[str, "Asset path (e.g., 'Materials/MyMaterial.mat') or search scope."],
2222
asset_type: Annotated[str,
2323
"Asset type (e.g., 'Material', 'Folder') - required for 'create'."] | None = None,

UnityMcpBridge/UnityMcpServer~/src/tools/manage_editor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def register_manage_editor_tools(mcp: FastMCP):
1515
def manage_editor(
1616
ctx: Context,
1717
action: Annotated[Literal["telemetry_status", "telemetry_ping", "play", "pause", "stop", "get_state", "get_project_root", "get_windows",
18-
"get_active_tool", "get_selection", "get_prefab_stage", "set_active_tool", "add_tag", "remove_tag", "get_tags", "add_layer", "remove_layer", "get_layers"], "Operations"],
18+
"get_active_tool", "get_selection", "get_prefab_stage", "set_active_tool", "add_tag", "remove_tag", "get_tags", "add_layer", "remove_layer", "get_layers"], "Get and update the Unity Editor state."],
1919
wait_for_completion: Annotated[bool,
2020
"Optional. If True, waits for certain actions"] | None = None,
2121
tool_name: Annotated[str,

UnityMcpBridge/UnityMcpServer~/src/tools/manage_gameobject.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def register_manage_gameobject_tools(mcp: FastMCP):
1313
@telemetry_tool("manage_gameobject")
1414
def manage_gameobject(
1515
ctx: Context,
16-
action: Literal["create", "modify", "delete", "find", "add_component", "remove_component", "set_component_property", "get_components"],
16+
action: Annotated[Literal["create", "modify", "delete", "find", "add_component", "remove_component", "set_component_property", "get_components"], "Perform CRUD operations on GameObjects and components."],
1717
target: Annotated[str,
1818
"GameObject identifier by name or path for modify/delete/component actions"] | None = None,
1919
search_method: Annotated[str,

UnityMcpBridge/UnityMcpServer~/src/tools/manage_menu_item.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def register_manage_menu_item_tools(mcp: FastMCP):
1717
@telemetry_tool("manage_menu_item")
1818
async def manage_menu_item(
1919
ctx: Context,
20-
action: Annotated[Literal["execute", "list", "exists"], "Operations"],
20+
action: Annotated[Literal["execute", "list", "exists"], "Read and execute Unity menu items."],
2121
menu_path: Annotated[str,
2222
"Menu path for 'execute' or 'exists' (e.g., 'File/Save Project')"] | None = None,
2323
search: Annotated[str,

UnityMcpBridge/UnityMcpServer~/src/tools/manage_prefabs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def manage_prefabs(
1818
"close_stage",
1919
"save_open_stage",
2020
"create_from_gameobject",
21-
], "Operations"],
21+
], "Manage prefabs (stage control and creation)."],
2222
prefab_path: Annotated[str,
2323
"Prefab asset path relative to Assets e.g. Assets/Prefabs/favorite.prefab"] | None = None,
2424
mode: Annotated[str,

UnityMcpBridge/UnityMcpServer~/src/tools/manage_scene.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def register_manage_scene_tools(mcp: FastMCP):
1313
@telemetry_tool("manage_scene")
1414
def manage_scene(
1515
ctx: Context,
16-
action: Annotated[Literal["create", "load", "save", "get_hierarchy", "get_active", "get_build_settings"], "Operations"],
16+
action: Annotated[Literal["create", "load", "save", "get_hierarchy", "get_active", "get_build_settings"], "Perform CRUD operations on Unity scenes."],
1717
name: Annotated[str,
1818
"Scene name. Not required get_active/get_build_settings"] | None = None,
1919
path: Annotated[str,

UnityMcpBridge/UnityMcpServer~/src/tools/manage_script.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ def validate_script(
455455
@telemetry_tool("manage_script")
456456
def manage_script(
457457
ctx: Context,
458-
action: Annotated[Literal['create', 'read', 'delete'], "Operations"],
458+
action: Annotated[Literal['create', 'read', 'delete'], "Perform CRUD operations on C# scripts."],
459459
name: Annotated[str, "Script name (no .cs extension)", "Name of the script to create"],
460460
path: Annotated[str, "Asset path (default: 'Assets/')", "Path under Assets/ to create the script at, e.g., 'Assets/Scripts/My.cs'"],
461461
contents: Annotated[str, "Contents of the script to create",

UnityMcpBridge/UnityMcpServer~/src/tools/manage_shader.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ def register_manage_shader_tools(mcp: FastMCP):
1414
@telemetry_tool("manage_shader")
1515
def manage_shader(
1616
ctx: Context,
17-
action: Annotated[Literal['create', 'read', 'update', 'delete'], "Operations"],
17+
action: Annotated[Literal['create', 'read', 'update', 'delete'], "Perform CRUD operations on shader scripts."],
1818
name: Annotated[str, "Shader name (no .cs extension)"],
1919
path: Annotated[str, "Asset path (default: \"Assets/\")"],
2020
contents: Annotated[str,

UnityMcpBridge/UnityMcpServer~/src/tools/read_console.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def register_read_console_tools(mcp: FastMCP):
1616
@telemetry_tool("read_console")
1717
def read_console(
1818
ctx: Context,
19-
action: Annotated[Literal['get', 'clear'], "Operations"],
19+
action: Annotated[Literal['get', 'clear'], "Get or clear the Unity Editor console."],
2020
types: Annotated[list[Literal['error', 'warning',
2121
'log', 'all']], "Message types to get"] | None = None,
2222
count: Annotated[int, "Max messages to return"] | None = None,

0 commit comments

Comments
 (0)