### Example Parse Repository Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

A pulse button to initiate the repository parsing process. When activated, it starts the analysis.

```python
op('source_github').par.Parse
```

--------------------------------

### Example Agent Workflow for Summarization

Source: https://docs.dotsimulate.com/operators/rag/source_crawl4ai

This example demonstrates a natural language prompt that an agent can use to request summarization of a specific URL and an overview of product pages from a website. The agent would then utilize the crawl tools to fulfill this request.

```text
"Summarize the main points from https://example.com/news/latest and give me an overview of their product pages."
```

--------------------------------

### Install uv Package Manager

Source: https://docs.dotsimulate.com/operators/system/sidecar

Use this command to install the uv dependency manager if it is not found.

```bash
pip install uv
```

--------------------------------

### Setup and Configuration

Source: https://docs.dotsimulate.com/operators/lops-controls/flow_controller

Parameters for configuring the target component and IOP shortcuts.

```APIDOC
## Setup and Configuration

### Description
These parameters manage the target component, IOP slot setup, and callback definitions.

### Parameters
- **Target Component** (OP) - op('flow_controller').par.Targetcomp - The component to manage as a flow.
- **Flow Name** (Str) - op('flow_controller').par.Flowname - Human-readable name for this flow.
- **Setup** (Pulse) - op('flow_controller').par.Setup - Setup the Internal OP shortcut on target component.
- **Cleanup** (Pulse) - op('flow_controller').par.Cleanup - Remove the Internal OP shortcut from target component.
- **Callbacks DAT** (OP) - op('flow_controller').par.Callbackdat - DAT with callback functions.
```

--------------------------------

### Install / Debug Controls

Source: https://docs.dotsimulate.com/operators/lops-controls/mcp_client

Tools for installing dependencies, debugging, and testing the MCP client.

```APIDOC
## Install / Debug Controls

### Description
Tools for installing dependencies, debugging, and testing the MCP client.

### Parameters
#### Install / Debug Section
- **Status** (Str) - Read-only - Current status of the installation/debugging process.
- **Install Dependencies** (Pulse) - Triggers the installation of necessary dependencies.
- **Check Dependencies** (Pulse) - Checks for the presence and validity of dependencies.
- **Auto-Sync on Config Change** (Toggle) - Automatically synchronizes when the configuration changes.
- **Call Test Tool** (Pulse) - Executes a test tool.
- **Test Tool Name** (Str) - Name of the test tool to execute.
- **Test Tool Arguments (JSON)** (Str) - JSON string containing arguments for the test tool.
```

--------------------------------

### Troubleshooting Guide

Source: https://docs.dotsimulate.com/operators/rag/source_ops

Common issues and their solutions for the dotsimulate project.

```APIDOC
## Troubleshooting

### "path column not found" error

**Description:** The OP Find DAT connected to **Custom Op Find** must have a column named `path`. If you are using a custom DAT, make sure it outputs operator paths in that column.

### Operators missing from results

**Description:** Check your OP Find filter settings. Pulse **Open Op Find pars** to review what the filter is matching. The **Component** parameter sets the root — operators outside that component tree are not discovered.

### Parsing is slow

**Description:** Reduce scope with tighter OP Find filters, or disable detail toggles you do not need (especially **Include Parameters** with **All Pars** on large networks).
```

--------------------------------

### GLSL Setup Parameters

Source: https://docs.dotsimulate.com/operators/other/glsl_creator

Configuration parameters for GLSL shader uniforms and output settings.

```APIDOC
## GLSL Setup Parameters

### Parameters
- **Time** (Float) - Optional - The current time passed as a uniform.
- **Color** (RGBA) - Optional - The color passed as a uniform.
- **Mouseuv** (UV) - Optional - The mouse UV coordinates passed as a uniform.
- **Outputresolution** (Menu) - Optional - Determines the output resolution of the GLSL TOP.
- **Resolution** (XY) - Optional - Custom resolution values.
- **Trueres** (XY) - Optional - Displays the actual resolution.
- **Useinput0** (Toggle) - Optional - Enables first input TOP.
- **Useinput1** (Toggle) - Optional - Enables second input TOP.
- **Useinput2** (Toggle) - Optional - Enables third input TOP.
```

--------------------------------

### Example Display Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

Controls the display mode, with options for 'index' or 'content'. Defaults to 'index'.

```python
op('source_github').par.Display
```

--------------------------------

### Troubleshooting Guide

Source: https://docs.dotsimulate.com/operators/utility/tox_updater

Common issues and their solutions for the DOTsimulate operator.

```APIDOC
## Troubleshooting

### Sign In button does nothing after pulsing
- **Cause**: A previous authentication attempt may still be in progress.
- **Solution**: Check the **Auth Status** field. If it shows `Waiting for browser...` but the browser never opened, reload the operator or restart TouchDesigner and try again.

### “Please sign in first” appears when checking or downloading
- **Cause**: The **Auth Status** field shows `Not signed in` or `Session expired`.
- **Solution**: Pulse **Sign In** to re-authenticate, then retry.

### “Subscription required” error when downloading
- **Cause**: Your account’s subscription is not active. The **Subscription** field shows `Inactive`.
- **Solution**: Check your subscription status at the DOTsimulate website.

### The Operator menu shows “Check for updates first” after launch
- **Cause**: If the operator has never run a registry check on this machine, the menu starts empty.
- **Solution**: Pulse **Check for Updates** to populate it. If a previous check was run, the cached list loads automatically on startup within a few seconds.

### “No LOPs basefolder configured” error
- **Cause**: The download path is not set in your ChatTD configuration.
- **Solution**: Configure the basefolder in ChatInstaller and try downloading again.

### Download completes but operator does not update in TouchDesigner
- **Cause**: Downloaded `.tox` files are written to disk but do not hot-reload into running projects.
- **Solution**: After downloading, replace or reimport the affected operators in your network manually.
```

--------------------------------

### Example Display File Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

Specifies a particular file to display content from. Defaults to an empty string.

```python
op('source_github').par.Displayfile
```

--------------------------------

### Troubleshooting Guide

Source: https://docs.dotsimulate.com/operators/other/rating

Common issues and their solutions for the Dotsimulate rating system.

```APIDOC
## Troubleshooting

### Error: Item is empty
**Description**: The **Item to Rate** field is blank. 
**Solution**: Enter a name before rating.
```

```APIDOC
### Ratings not saving
**Description**: Ratings are not being saved.
**Solution**: Check that **Storage Location** is set correctly. If using **Custom Folder**, ensure **Rating Folder** points to a valid, writable directory.
```

```APIDOC
### Agent cannot rate
**Description**: The agent is unable to perform ratings.
**Solution**: Verify that **Enable Tools** is turned on in the **GetTool** page. If **Agent Selects Item** is off, ensure **Item to Rate** has a value.
```

```APIDOC
### Undo does nothing
**Description**: The undo function is not working as expected.
**Solution**: Only the most recent rating can be undone. If you have already undone once or no rating has been made this session, there is nothing to reverse.
```

--------------------------------

### Verify uv Installation

Source: https://docs.dotsimulate.com/operators/system/sidecar

Run this command in a terminal to verify that uv is accessible.

```bash
uv --version
```

--------------------------------

### TTS ElevenLabs Callback Examples

Source: https://docs.dotsimulate.com/operators/pipelines/tts_elevenlabs

Example Python functions demonstrating how to implement callbacks for TTS ElevenLabs operations like generation, completion, playback, and saving. These functions receive an 'info' dictionary containing details about the operation.

```python
def onGenerate(info):
# Called before streaming starts
# info: {'job_id', 'text', 'voice_id', 'model_id'}
print(f"Starting generation job: {info.get('job_id')}")
```

```python
def onDone(info):
# Called when streaming finishes or errors
# info: {'job_id', 'status', 'message', 'duration', 'text', 'voice_id', 'model_id'}
print(f"Generation finished: {info.get('status')} ({info.get('duration')}s)")
```

```python
def onPlayStart(info):
# Called when playback starts
# info: {'job_id', 'audio_duration', 'text'}
print(f"Playback started for job: {info.get('job_id')}")
```

```python
def onPlayEnd(info):
# Called when playback ends
# info: {'job_id', 'audio_duration', 'text'}
print(f"Playback finished for job: {info.get('job_id')}")
```

```python
def onSave(info):
# Called after audio is saved successfully
# info: {'job_id', 'filepath', 'filename', 'folder', 'duration', 'text'}
print(f"Audio saved to: {info.get('filepath')}")
```

--------------------------------

### Example Use Authentication Toggle

Source: https://docs.dotsimulate.com/operators/rag/source_github

A toggle to enable or disable authentication for accessing GitHub. Defaults to False.

```python
op('source_github').par.Useauth
```

--------------------------------

### Example Doc File Patterns Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

Specifies patterns for documentation files to be included. Defaults to an empty string.

```python
op('source_github').par.Docpatterns
```

--------------------------------

### Dependency Management

Source: https://docs.dotsimulate.com/operators/rag/source_crawl4ai

Manage the installation and checking of necessary dependencies and browser binaries.

```APIDOC
## Dependency Management

### Install Dependencies (Installdependencies)

Pulse button to install `crawl4ai` and `playwright` packages.

**Default:** `False`

### Check Dependencies (Checkdependencies)

Pulse button to check the status of required dependencies.

**Default:** `False`

### Install Browsers (Installbrowsers)

Pulse button to run `playwright install` to download necessary browser binaries.

**Default:** `False`
```

--------------------------------

### Example Repository URL Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

This parameter specifies the GitHub repository URL to be analyzed. Ensure it follows the format 'github.com/owner/repo'.

```python
op('source_github').par.Repourl
```

--------------------------------

### Example Include Context Toggle

Source: https://docs.dotsimulate.com/operators/rag/source_github

A toggle to include contextual information during analysis. Defaults to False.

```python
op('source_github').par.Includecontext
```

--------------------------------

### Example Current Status Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

Displays the current status of the repository parsing process. This is a read-only parameter.

```python
op('source_github').par.Status
```

--------------------------------

### Example Include Wiki Toggle

Source: https://docs.dotsimulate.com/operators/rag/source_github

A toggle to include or exclude the repository's wiki content from the analysis. Defaults to False.

```python
op('source_github').par.Includewiki
```

--------------------------------

### Get API Key Button

Source: https://docs.dotsimulate.com/operators/pipelines/serper_search

The 'Get API Key' button, when activated, opens the serper.dev website in your browser to assist in obtaining an API key.

```text
Get API Key (Getapikey) `op('serper_search').par.Getapikey` Pulse
Opens serper.dev in your browser to get an API key. 

Default:
    `False`
```

--------------------------------

### Install Python 3.11 with Homebrew on macOS

Source: https://docs.dotsimulate.com/guides/installation

Use Homebrew to install a specific version of Python required for LOPs. Ensure you are using Python 3.11.9 for compatibility.

```bash
brew install python@3.11
```

--------------------------------

### Install Local Embeddings for RAG Indexer

Source: https://docs.dotsimulate.com/guides/installation

Install the necessary package for RAG operations that utilize local embeddings with Ollama. This command should be run within the TouchDesigner virtual environment.

```bash
pip install llama-index-embeddings-ollama
```

--------------------------------

### Example Include Documentation Toggle

Source: https://docs.dotsimulate.com/operators/rag/source_github

A toggle to include documentation files in the analysis. It's recommended to enable this first for initial parsing. Defaults to False.

```python
op('source_github').par.Includedocs
```

--------------------------------

### MCP Client Operator Callback Example

Source: https://docs.dotsimulate.com/lops_controls/mcp_client

This is an example of the `onToolCallComplete` callback structure. It is triggered after an MCP tool call finishes and provides information about the call's status and response.

```python
def onToolCallComplete(info):
# Called after an MCP tool call completes.
# info dictionary contains details like:
# - status: 'success' or 'error'
# - response: The result of the tool call (if successful)

```

--------------------------------

### Context Configuration

Source: https://docs.dotsimulate.com/operators/llm/agent

Configure context settings, including context operator and audio/image inputs.

```APIDOC
## Context Configuration

### Context Op (Contextop)
- **Type**: OP
- **Default**: `"" (Empty String)`

### Use Audio (Useaudio)
- **Type**: Toggle
- **Default**: `False`

### Audio File (Audiofile)
- **Type**: File
- **Default**: `"" (Empty String)`

### Send TOP Image (Sendtopimage)
- **Type**: Toggle
- **Default**: `False`
- **Description**: If enabled, send the TOP specified in Topimage directly with the prompt.

### TOP Image (Topimage)
- **Type**: TOP
- **Default**: `"" (Empty String)`
- **Description**: Specify a TOP operator to send as an image.
```

--------------------------------

### Example Progress Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

Indicates the progress of the repository parsing, represented as a float between 0.0 and 1.0. A slider range of 0 to 100 is also provided for user interaction.

```python
op('source_github').par.Progress
```

--------------------------------

### Best Practices

Source: https://docs.dotsimulate.com/operators/lops-controls/agent_session

Recommendations for optimizing Agent Session usage, including history management, context window, and prompt caching.

```APIDOC
## Best Practices

*   **Let Agent Session manage history**: It handles message IDs, timestamps, deduplication, and tool call/result pairing automatically.
*   **Use Conservative or Aggressive pruning**: For long-running sessions to avoid exceeding context windows. The Intelligent strategy preserves important messages while trimming older small messages.
*   **Enable Prompt Caching**: For multi-turn sessions where the conversation prefix stays stable to reduce costs on caching-capable providers.
*   **Use Auto Name Session**: For dashboard workflows where users need to identify sessions at a glance.
```

--------------------------------

### Best Practices for Tool Configuration

Source: https://docs.dotsimulate.com/operators/llm/tool_parameter

Recommendations for effectively configuring tools for agent interaction.

```APIDOC
## Best Practices

- Give each tool a clear, descriptive **Tool Name**.
- Use **Description** to add context about the operator's function.
- Start with **Enable Set Current Values** and **Enable Get Current Values** enabled.
- Use the **Mode** menu to set tools to “forced” when they are mandatory.
- Toggle **Enable / Expose Tool** off to temporarily hide all tools.
```

--------------------------------

### Example Clear All Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

A pulse button to clear all parsed data and reset the analysis state.

```python
op('source_github').par.Clear
```

--------------------------------

### Example Callback Structure

Source: https://docs.dotsimulate.com/operators/llm/hold_chat

Standard structure for implementing hold event callbacks in the callback DAT.

```python
def onHold(info):
# Called when any hold becomes active
# info: {'Hold': True}
pass

def onHoldEnd(info):
# Called when all holds become inactive
# info: {'Hold': False}
pass

def onTokenThreshold(info):
# Called when token count exceeds threshold
# info: {'Hold': True, 'Type': 'TokenThreshold'}
pass

def onTokenThresholdEnd(info):
# Called when token count drops below threshold
# info: {'Hold': False, 'Type': 'TokenThreshold'}
pass

def onMessageThreshold(info):
# Called when message count exceeds threshold
# info: {'Hold': True, 'Type': 'MessageThreshold'}
pass

def onMessageThresholdEnd(info):
# Called when message count drops below threshold
# info: {'Hold': False, 'Type': 'MessageThreshold'}
pass

def onManual(info):
# Called when manual hold is activated
# info: {'Hold': True, 'Type': 'ManualHold'}
pass

def onManualEnd(info):
# Called when manual hold is deactivated
# info: {'Hold': False, 'Type': 'ManualHold'}
pass
```

--------------------------------

### Example GitHub Token Parameter

Source: https://docs.dotsimulate.com/operators/rag/source_github

Provides the GitHub Personal Access Token (PAT) for authenticated requests. An empty string indicates no token is provided.

```python
op('source_github').par.Token
```

--------------------------------

### Example Include Issues/PRs Toggle

Source: https://docs.dotsimulate.com/operators/rag/source_github

A toggle to include issues and pull requests in the analysis. Defaults to False.

```python
op('source_github').par.Includeissues
```

--------------------------------

### Configuration Parameters

Source: https://docs.dotsimulate.com/operators/other/glsl_creator

Parameters for saving, loading, and managing shader versions.

```APIDOC
## Configuration Parameters

### Parameters
- **Loadversion** (Menu) - Optional - Selects a specific version of the shader to load.
- **Saveshader** (Pulse) - Optional - Saves the current shader code and metadata.
- **Loadshader** (Pulse) - Optional - Loads the selected shader version.
- **Autoload** (Toggle) - Optional - Automatically loads the selected shader version.
- **Savefolder** (Folder) - Optional - Specifies the base folder for saving and loading.
```

--------------------------------

### Example Callback Structures

Source: https://docs.dotsimulate.com/operators/llm/summarize

Implement these functions to hook into task lifecycle events. The `onTaskStart` function is called when an API call begins, and `onTaskComplete` is called upon completion, providing access to results.

```python
def onTaskStart(info):
# Called when the summarization API call begins
pass
```

```python
def onTaskComplete(info):
# Called when summarization finishes
# The summary text is available in the Summary parameter and summary_dat output
pass
```