You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update documentation for unity_reflect and unity_docs tools
- manifest.json: add both tools in alphabetical order
- README.md: add to Available Tools, update Recent Updates
- README-zh.md: mirror changes in Chinese
- SKILL.md: add Docs group to tool categories with trust hierarchy
- tools-reference.md: full reference for both tools with examples
- workflows.md: add 5 API verification workflow patterns
|**Packages**|`manage_packages`| Install, remove, search, and manage Unity packages and scoped registries. Query actions: list installed, search registry, get info, ping, poll status. Mutating actions: add/remove packages, embed for editing, add/remove scoped registries, force resolve. Validates identifiers, warns on git URLs, checks dependents before removal (`force=true` to override). See [tools-reference.md](references/tools-reference.md#package-tools). |
191
191
|**ProBuilder**|`manage_probuilder`| 3D modeling, mesh editing, complex geometry. **When `com.unity.probuilder` is installed, prefer ProBuilder shapes over primitive GameObjects** for editable geometry, multi-material faces, or complex shapes. Supports 12 shape types, face/edge/vertex editing, smoothing, and per-face materials. See [ProBuilder Guide](references/probuilder-guide.md). |
192
192
|**UI**|`manage_ui`, `batch_execute` with `manage_gameobject` + `manage_components`|**UI Toolkit**: Use `manage_ui` to create UXML/USS files, attach UIDocument, inspect visual trees. **uGUI (Canvas)**: Use `batch_execute` for Canvas, Panel, Button, Text, Slider, Toggle, Input Field. **Read `mcpforunity://project/info` first** to detect uGUI/TMP/Input System/UI Toolkit availability. (see [UI workflows](references/workflows.md#ui-creation-workflows)) |
193
+
|**Docs**|`unity_reflect`, `unity_docs`| API verification and documentation lookup. **`unity_reflect`** inspects live C# APIs via reflection (requires Unity connection): `search` types across assemblies, `get_type` for member summary, `get_member` for full signatures. **`unity_docs`** fetches official docs from docs.unity3d.com (no Unity connection needed): `get_doc` (ScriptReference), `get_manual` (Manual pages), `get_package_doc` (package docs), `lookup` (parallel search all sources + project assets). **Trust hierarchy: reflection > project assets > docs.** Workflow: `unity_reflect` search -> get_type -> get_member -> `unity_docs` lookup. See [tools-reference.md](references/tools-reference.md#docs-tools). |
See also: [ProBuilder Workflow Guide](probuilder-guide.md) for detailed patterns and complex object examples.
1283
+
1284
+
---
1285
+
1286
+
## Docs Tools
1287
+
1288
+
Tools for verifying Unity C# APIs and fetching official documentation. Group: `docs`.
1289
+
1290
+
### `unity_reflect`
1291
+
1292
+
Inspect Unity's live C# API via reflection. **Always use this before writing C# code that references Unity APIs** — LLM training data frequently contains incorrect, outdated, or hallucinated APIs.
1293
+
1294
+
Requires Unity connection.
1295
+
1296
+
| Parameter | Type | Required | Description |
1297
+
|-----------|------|----------|-------------|
1298
+
|`action`| string | Yes |`search`, `get_type`, or `get_member`|
1299
+
|`class_name`| string | For get_type, get_member | Fully qualified or simple C# class name |
1300
+
|`member_name`| string | For get_member | Method, property, or field name to inspect |
1301
+
|`query`| string | For search | Search query for type name search |
1302
+
|`scope`| string | No | Assembly scope for search: `unity`, `packages`, `project`, `all` (default: `unity`) |
1303
+
1304
+
**Actions:**
1305
+
1306
+
-**`search`**: Search for types by name across loaded assemblies. Returns matching type names.
1307
+
-**`get_type`**: Get a member summary (names only) for a class. Returns list of methods, properties, fields.
1308
+
-**`get_member`**: Get full signature detail for one member. Returns parameter types, return type, overloads.
Fetch official Unity documentation from docs.unity3d.com. Returns descriptions, parameter details, code examples, and caveats. Use after `unity_reflect` confirms a type exists.
1326
+
1327
+
No Unity connection needed for doc fetching. The `lookup` action with asset-related queries will also search project assets (requires Unity connection).
1328
+
1329
+
| Parameter | Type | Required | Description |
1330
+
|-----------|------|----------|-------------|
1331
+
|`action`| string | Yes |`get_doc`, `get_manual`, `get_package_doc`, or `lookup`|
1332
+
|`class_name`| string | For get_doc | Unity class name (e.g., `Physics`, `Transform`) |
1333
+
|`member_name`| string | No | Method or property name for get_doc |
1334
+
|`version`| string | No | Unity version (e.g., `6000.0.38f1`). Auto-extracts major.minor. |
-**`get_doc`**: Fetch ScriptReference docs for a class or member. Parses HTML to extract description, signatures, parameters, return type, and code examples.
1345
+
-**`get_manual`**: Fetch a Unity Manual page by slug. Returns title, sections, and code examples.
***v9.5.4 (beta)** — New `manage_packages` tool: install, remove, search, and manage Unity packages and scoped registries. Includes input validation, dependency checks on removal, and git URL warnings.
23
+
***v9.5.4 (beta)** — New `unity_reflect` and `unity_docs` tools for API verification: inspect live C# APIs via reflection and fetch official Unity documentation (ScriptReference, Manual, package docs). New `manage_packages` tool: install, remove, search, and manage Unity packages and scoped registries. Includes input validation, dependency checks on removal, and git URL warnings.
***v9.5.2** — New `manage_camera` tool with Cinemachine support (presets, priority, noise, blending, extensions), `cameras` resource, priority persistence fix via SerializedProperty.
26
26
***v9.4.8** — New editor UI, real-time tool toggling via `manage_tools`, skill sync window, multi-view screenshot, one-click Roslyn installer, Qwen Code & Gemini CLI clients, ProBuilder mesh editing via `manage_probuilder`.
|**Packages**|`manage_packages`| Install, remove, search, and manage Unity packages and scoped registries. Query actions: list installed, search registry, get info, ping, poll status. Mutating actions: add/remove packages, embed for editing, add/remove scoped registries, force resolve. Validates identifiers, warns on git URLs, checks dependents before removal (`force=true` to override). See [tools-reference.md](references/tools-reference.md#package-tools). |
191
191
|**ProBuilder**|`manage_probuilder`| 3D modeling, mesh editing, complex geometry. **When `com.unity.probuilder` is installed, prefer ProBuilder shapes over primitive GameObjects** for editable geometry, multi-material faces, or complex shapes. Supports 12 shape types, face/edge/vertex editing, smoothing, and per-face materials. See [ProBuilder Guide](references/probuilder-guide.md). |
192
192
|**UI**|`manage_ui`, `batch_execute` with `manage_gameobject` + `manage_components`|**UI Toolkit**: Use `manage_ui` to create UXML/USS files, attach UIDocument, inspect visual trees. **uGUI (Canvas)**: Use `batch_execute` for Canvas, Panel, Button, Text, Slider, Toggle, Input Field. **Read `mcpforunity://project/info` first** to detect uGUI/TMP/Input System/UI Toolkit availability. (see [UI workflows](references/workflows.md#ui-creation-workflows)) |
193
+
|**Docs**|`unity_reflect`, `unity_docs`| API verification and documentation lookup. **`unity_reflect`** inspects live C# APIs via reflection (requires Unity connection): `search` types across assemblies, `get_type` for member summary, `get_member` for full signatures. **`unity_docs`** fetches official docs from docs.unity3d.com (no Unity connection needed): `get_doc` (ScriptReference), `get_manual` (Manual pages), `get_package_doc` (package docs), `lookup` (parallel search all sources + project assets). **Trust hierarchy: reflection > project assets > docs.** Workflow: `unity_reflect` search -> get_type -> get_member -> `unity_docs` lookup. See [tools-reference.md](references/tools-reference.md#docs-tools). |
0 commit comments