Skip to content

Commit 9f1ad30

Browse files
TMHSDigitalclaude
andcommitted
docs: align MCP tool docs with actual behavior
Remove the ECS scaffolding claim and the "200+ entries" count, and document target_type, ranked search, URP-only HLSL, data path behavior, and how to run the tests. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MpEiWjv38TrdFcgqU8ER5L
1 parent b208401 commit 9f1ad30

3 files changed

Lines changed: 21 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a
7171
7272
## Features
7373

74-
- **Script scaffolding** -- Generate MonoBehaviours, ScriptableObjects, Editor windows, and ECS systems following Unity 6 conventions
74+
- **Script scaffolding** -- Generate MonoBehaviours, ScriptableObjects, Editor windows, inspectors, state machines, and tests following Unity 6 conventions
7575
- **API lookup** -- Search common Unity APIs by name, namespace, or category via MCP tools
7676
- **Shader patterns** -- Get HLSL code and Shader Graph node setups for common effects (dissolve, outline, hologram, etc.)
7777
- **Performance-aware coding rules** -- Catch deprecated APIs, allocation-heavy patterns, and common mistakes
@@ -243,7 +243,7 @@ The server starts automatically when Cursor invokes an MCP tool.
243243

244244
| Tool | Description |
245245
|:-----|:------------|
246-
| `scaffold_script` | Generate C# scripts following Unity 6 conventions. Supports MonoBehaviour, ScriptableObject, Editor, and ECS templates. |
246+
| `scaffold_script` | Generate C# scripts following Unity 6 conventions. Supports MonoBehaviour, ScriptableObject, Editor window, custom inspector, property drawer, interface, state machine, and test templates. |
247247
| `lookup_api` | Search the Unity API reference database by name, namespace, or category. Returns signatures, descriptions, and examples. |
248248
| `shader_helper` | Get shader code patterns for common effects (dissolve, outline, hologram, etc.) with HLSL and Shader Graph guidance. |
249249
| `platform_info` | Get platform-specific defines, capabilities, limitations, and build recommendations. |

‎docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Unity Developer Tools is a plugin for [Cursor](https://www.cursor.com/) that teaches its AI assistant how to build Unity games and tools. Once installed, you can ask the AI to:
1212

13-
- Scaffold MonoBehaviours, ScriptableObjects, Editor windows, and ECS systems
13+
- Scaffold MonoBehaviours, ScriptableObjects, Editor windows, inspectors, and tests
1414
- Look up Unity APIs by name, namespace, or category
1515
- Generate shader patterns for common effects (dissolve, outline, hologram, etc.)
1616
- Get platform-specific defines, capabilities, and build recommendations
@@ -29,7 +29,7 @@ For a detailed walkthrough, see the [Getting Started guide](GETTING-STARTED.md).
2929

3030
## Features
3131

32-
- **Script scaffolding** -- Generate MonoBehaviours, ScriptableObjects, Editor windows, and ECS systems following Unity 6 conventions
32+
- **Script scaffolding** -- Generate MonoBehaviours, ScriptableObjects, Editor windows, inspectors, state machines, and tests following Unity 6 conventions
3333
- **API lookup** -- Search common Unity APIs by name, namespace, or category via MCP tools
3434
- **Shader patterns** -- Get HLSL code and Shader Graph node setups for common effects
3535
- **Performance-aware coding rules** -- Catch deprecated APIs, allocation-heavy patterns, and common mistakes

‎mcp-server/README.md‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@ A Model Context Protocol server providing Unity development tools for the Cursor
77
### scaffold_script
88
Generate well-structured C# scripts following Unity conventions.
99
- **type**: monobehaviour, scriptableobject, editor-window, custom-inspector, property-drawer, interface, state-machine, test
10-
- **name**: Class name for the generated script
10+
- **name**: Class name for the generated script (must be a valid C# identifier)
1111
- **namespace**: Optional namespace (default: MyGame)
12+
- **target_type**: Type inspected or drawn, for custom-inspector and property-drawer. Defaults to the name without its Editor/Inspector/Drawer suffix (`PlayerEditor` -> `Player`)
1213

1314
### lookup_api
14-
Search the Unity API reference database for classes, methods, and usage patterns.
15+
Search the Unity API reference database for classes, methods, and usage patterns. Multi-word queries match entries containing every word; exact name matches rank first.
1516
- **query**: Search term (class name, method name, or keyword)
16-
- **category**: Optional filter (physics, ui, animation, audio, rendering, input, networking, editor)
17+
- **category**: Optional filter (general, physics, ui, animation, audio, rendering, input, networking, editor)
1718

1819
### shader_helper
19-
Get shader code patterns and property setups for common effects.
20+
Get shader code patterns and property setups for common effects. Hand-written HLSL currently targets URP; HDRP and Built-in requests return properties and Shader Graph guidance only.
2021
- **effect**: Effect name (dissolve, outline, toon, water, hologram, fresnel)
2122
- **pipeline**: Target render pipeline (urp, hdrp, builtin)
2223

@@ -34,9 +35,20 @@ pip install -r requirements.txt
3435
python server.py
3536
```
3637

38+
The server reads its data from `data/` next to `server.py`, so it can be started from any directory. Set `UNITY_DATA_PATH` to use a different data folder. If a data file is missing, the server exits with an error instead of returning empty results.
39+
40+
## Testing
41+
42+
```bash
43+
pip install -r requirements-dev.txt
44+
python -m pytest tests
45+
```
46+
47+
The suite covers every tool and includes a stdio smoke test that starts the server and calls it through the MCP client.
48+
3749
## Data Files
3850

39-
- `unity_api_common.json` - Common Unity API reference (200+ classes and methods)
51+
- `unity_api_common.json` - Curated Unity 6 API reference (75 entries across 9 categories)
4052
- `shader_properties.json` - Built-in shader properties and effect patterns
4153
- `platform_defines.json` - Platform scripting defines and capabilities
4254
- `lifecycle_order.json` - MonoBehaviour execution order reference

0 commit comments

Comments
 (0)