Files

T

Shutong Wu bc9499b203 fix(docs-gen): smarter sentence split for frontmatter descriptions

PR #1157 review (Copilot + CodeRabbit) flagged that several tool pages
had truncated frontmatter, e.g. manage_asset rendering as:
  description: "Performs asset operations (import, create, modify, delete, etc"

Root cause: the generator used `description.split(".")[0]` to derive the
frontmatter blurb. That cuts at the FIRST period — including periods
inside abbreviations and parenthesized lists ("etc.) in Unity."), so
the rendered description stopped mid-clause.

Fix: introduce `_first_sentence()` that splits on real sentence
boundaries — `.` / `!` / `?` followed by whitespace + capital, or a
paragraph break — and falls back to the whole string if no boundary
exists. Also caps absurdly long single-sentence descriptions at ~240
chars to keep frontmatter compact.

All three call sites that used the old split:
- frontmatter `description:` in render_tool_page
- group-index bullets in render_group_index
- catalog-index bullets in render_catalog_index

Regenerated all 43 tool pages + 9 group landings + catalog index +
resources catalog. Verified `--check` passes round-trip and full
website build is clean.

manage_asset now reads: "Performs asset operations (import, create,
modify, delete, etc.) in Unity."

2026-05-25 02:56:06 +08:00

2.3 KiB

Raw Permalink Blame History

title, sidebar_label, description

title	sidebar_label	description
execute_code	execute_code	Execute arbitrary C# code inside the Unity Editor.

`execute_code`

Auto-generated from the Python tool registry. Do not hand-edit outside  blocks — the generator (tools/generate_docs_reference.py) will overwrite them.

Group: scripting_ext · Module: services.tools.execute_code

Description

Execute arbitrary C# code inside the Unity Editor. The code runs as a method body with access to UnityEngine and UnityEditor namespaces. Use 'return' to send data back. Compiled in-memory — no script files created. Actions: execute (run code), get_history (list past executions), replay (re-run a history entry), clear_history. NOTE: safety_checks blocks known dangerous patterns but is not a full sandbox. Compiler options: 'auto' (Roslyn if available, else CodeDom), 'roslyn' (C# 12+, requires Microsoft.CodeAnalysis), 'codedom' (C# 6 only).

Parameters

Name	Type	Required	Description
`action`	`Literal['execute', 'get_history', 'replay', 'clear_history']`	yes	Action to perform.
`code`	`str \| None`	—	C# code to execute (for 'execute' action). Must be a valid method body. Access UnityEngine and UnityEditor namespaces. Use 'return' to send data back.
`safety_checks`	`bool`	—	Enable basic blocked-pattern checks (File.Delete, Process.Start, infinite loops, etc). Not a full sandbox — advanced bypass is possible. Default: true.
`index`	`int \| None`	—	History entry index to replay (for 'replay' action).
`limit`	`int`	—	Number of history entries to return (for 'get_history' action, 1-50). Default: 10.
`compiler`	`Literal['auto', 'roslyn', 'codedom']`	—	Compiler backend for 'execute' action. 'auto' uses Roslyn if Microsoft.CodeAnalysis is installed, else falls back to CodeDom. 'roslyn' forces Roslyn (C# 12+). 'codedom' forces legacy CSharpCodeProvider (C# 6). Default: auto.

Returns

A dict containing the Unity response. The exact shape depends on the action.

Examples

No examples yet. Add usage examples here — they will be preserved across regenerations.

2.3 KiB Raw Permalink Blame History

execute_code