Get build-aware TouchDesigner docs
get_td_docsFind TouchDesigner operator, Python, and concept documentation from installed or embedded sources, returning section IDs for targeted reading.
Instructions
Read-only: resolve compact TouchDesigner operator, Python API, or concept documentation from the installed OfflineHelp corpus first, then the embedded KB. Returns section ids for bounded drill-down plus installed/running build provenance. Web fallback is off by default and, when explicitly enabled, is restricted to docs.derivative.ca and labeled as latest-web rather than installed-build truth. Never accepts a filesystem path or returns raw HTML.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Documentation kind: auto, operator, python, or concept. | auto |
| query | Yes | Operator type, Python class/page id, or concept text; never a filesystem path. | |
| source | No | Source policy: installed, embedded, web, or local-first auto. | auto |
| section | No | Stable heading id or an exact unique section title from sections_available. | |
| max_chars | No | Maximum returned documentation body characters (1000-12000). | |
| web_fallback | No | Allow auto mode to try the Derivative web API when the server gate is enabled. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| query | Yes | ||
| status | Yes | ||
| content | No | ||
| warnings | Yes | ||
| candidates | Yes | ||
| provenance | Yes | ||
| content_chars | Yes | ||
| kind_requested | Yes | ||
| selected_section | No | ||
| content_truncated | Yes | ||
| sections_available | Yes | ||
| sections_truncated | Yes |