unity_docs

Auto-generated from the Python tool registry. Do not hand-edit outside <!-- examples:start --><!-- examples:end --> blocks — the generator (tools/generate_docs_reference.py) will overwrite them.

Group: docs  ·  Module: services.tools.unity_docs

Description

Fetch official Unity documentation from docs.unity3d.com. Returns descriptions, parameter details, code examples, and caveats. Use after unity_reflect confirms a type exists, to get usage patterns, gotchas, and code examples before writing implementation code.

Actions:

• get_doc: Fetch ScriptReference docs for a class or member. Requires class_name. Optional member_name, version.
• get_manual: Fetch a Unity Manual page. Requires slug (e.g., 'execution-order', 'urp/urp-introduction'). Optional version.
• get_package_doc: Fetch package documentation. Requires package, page, pkg_version (e.g., package='com.unity.render-pipelines.universal', page='2d-index', pkg_version='17.0').
• lookup: Search all doc sources in parallel (ScriptReference + Manual + package docs). Requires query or queries (comma-separated). Supports batch: queries='Physics.Raycast,NavMeshAgent,Light2D' searches all in one call. Optional package + pkg_version to also search package docs.

Parameters

Name	Type	Required	Description
action	str	yes	The documentation action to perform.
class_name	str | None	—	Unity class name (e.g. 'Physics', 'Transform').
member_name	str | None	—	Method or property name to look up.
version	str | None	—	Unity version (e.g. '6000.0.38f1'). Auto-extracted.
slug	str | None	—	Manual page slug (e.g., 'execution-order').
package	str | None	—	Package name (e.g., 'com.unity.render-pipelines.universal').
page	str | None	—	Package doc page (e.g., 'index', '2d-index').
pkg_version	str | None	—	Package version major.minor (e.g., '17.0').
query	str | None	—	Single search query for lookup (class name, topic, or slug).
queries	str | None	—	Comma-separated search queries for batch lookup (e.g., 'Physics.Raycast,NavMeshAgent,Light2D').

Returns

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

Examples

Look up several APIs in one call

Before writing the controller, pull the docs for raycasts, NavMeshAgent and script execution order.

{
  "action": "lookup",
  "queries": "Physics.Raycast,NavMeshAgent,execution-order"
}

Searches ScriptReference and the Manual in parallel and returns one results entry per query, each with its hits. Package docs are only searched when package and pkg_version are also given; the query is then tried as a page slug of that package (e.g. 2d-index with com.unity.render-pipelines.universal / 17.0).

Read one member's reference page

What are the parameters of Physics.Raycast?

{
  "action": "get_doc",
  "class_name": "Physics",
  "member_name": "Raycast"
}

Returns the description, signatures, parameters and code examples from docs.unity3d.com. Properties work too ("member_name": "linearVelocity" on Rigidbody) — if the method URL 404s, the property URL is tried.

Pin the docs to your Unity version

Get the 6000.0 page for Rigidbody.linearVelocity.

{
  "action": "get_doc",
  "class_name": "Rigidbody",
  "member_name": "linearVelocity",
  "version": "6000.0.38f1"
}

A full editor version is accepted and reduced to 6000.0; without version the latest docs are used.

Read a Manual page

How does Unity order Awake, OnEnable and Start?

{
  "action": "get_manual",
  "slug": "execution-order"
}

The slug is the page name from the Manual URL (docs.unity3d.com/Manual/execution-order.html).

Read package documentation

Show the URP 2D lighting overview.

{
  "action": "get_package_doc",
  "package": "com.unity.render-pipelines.universal",
  "page": "2d-index",
  "pkg_version": "17.0"
}

All three parameters are required. pkg_version is major.minor of the package, not the editor version.

Pair it with unity_reflect: reflect confirms the API exists in the open editor, docs explain how to use it.