Skip to content

README.md

Latest commit

 

History

History
61 lines (43 loc) · 2 KB

README.md

File metadata and controls

61 lines (43 loc) · 2 KB
Raw

TouchDesigner API Lookup Skill

中文說明 (Chinese Version)

A toolset designed for AI Agents (such as Claude or Cursor) to query local TouchDesigner API documentation and Class references. It includes a set of Python scripts and a pre-fetched JSON database.

Note: All data and documentation sources are from the official TouchDesigner Wiki.

✨ Features

  • Local Lookup: Quickly query TouchDesigner Operator parameters and Python Class methods without an internet connection.
  • AI Integration: Includes SKILL.md, ready to be used as an Agent Skill for Cursor or Claude.
  • Auto Update: Built-in scrape_docs.py scraper to sync the latest documentation from the TouchDesigner Wiki.

📦 Installation

  1. Clone this repo into your project's Skill directory (e.g., .cursor/skills/ or .claude/skills/):

    git clone https://github.com/j19950310/TouchDesignerNodeAgentSkills.git

  2. Install Python dependencies:

    pip install -r requirements.txt

🚀 Usage

As an Agent Skill

Place this folder in the skills directory specified by your AI editor and ensure the AI can read SKILL.md.

Note: Please adjust the file paths in SKILL.md according to the actual location where you place this Skill.

Manual Execution

You can also run the scripts directly in the terminal:

  • List Class Members & Methods:

    python scripts/list_class.py NoisePOP

  • Query Details:

    python scripts/get_detail.py NoisePOP seed

  • Update Documentation Database:

    python scripts/scrape_docs.py NoisePOP
# Or sync all classes
python scripts/scrape_docs.py --category --limit 10

📂 File Structure

  • SKILL.md: Defines the Prompt for how the Agent should use this tool.
  • scripts/: Contains the core Python code for querying and scraping.
  • references/: Stores the scraped JSON documentation data.

License

MIT