From 016fe7c38cea6c659fbecc0458e1deed6a8ad554 Mon Sep 17 00:00:00 2001 From: Ziforge Date: Wed, 9 Sep 2026 07:44:30 +0200 Subject: [PATCH] Docs: fix 404 README links, document LOM-unsupported tools; rename $Host MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - README: replace dead API_REFERENCE.md / TROUBLESHOOTING.md links with docs that exist (ARCHITECTURE, Windows install notes, smoke-test runbook) + point to the live get_available_tools action. - Add a "Not supported by the Live API" section listing the GUI-only tools that now return honest errors (grouping, freeze/flatten, delay, annotations, follow-actions, groove, take-lane delete, metronome volume) — per issue #3. - Qualify the "220 tools" total accordingly. - run_smoke_test.ps1: rename $Host param to $TargetHost (avoids shadowing the PowerShell built-in $Host automatic variable). Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 17 ++++++++++++++--- scripts/windows/run_smoke_test.ps1 | 4 ++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4664ec0..2aee984 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ This implementation provides **220 tools across 44 categories** based on: | **Display Values** | 2 | Get parameter values as shown in UI | | **Additional Properties** | 10 | Clip start time, track/scene states, signatures | -**Total: 220 Tools** +**Total: ~220 Tools** (a handful are GUI-only in Live and return an honest "not exposed by the Live Object Model" error — see [Not supported by the Live API](#not-supported-by-the-live-api)). ## Quick Start @@ -170,8 +170,19 @@ send_command('launch_clip', track_index=track_index, scene_index=0) ## Documentation - **[Installation Guide](docs/INSTALLATION.md)** - Detailed installation instructions -- **[API Reference](docs/API_REFERENCE.md)** - Complete list of all 220 tools -- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions +- **[Architecture](docs/ARCHITECTURE.md)** - How the socket server / queue works +- **[Windows install notes](docs/install-notes-windows.md)** and **[smoke-test runbook](docs/smoke-test-runbook.md)** - Windows deploy + validation +- The live, authoritative tool list is always available via the `get_available_tools` action. + +### Not supported by the Live API + +A few advertised actions reference Live Object Model members that don't exist in +current Live (verified on 12.4), so they return an honest +`{"ok": false, "error": "... not exposed by the Live Object Model"}` rather than +silently doing nothing: track **grouping / ungroup**, track **freeze / flatten**, +**track delay**, **track & clip annotations**, **clip follow-actions**, track +**groove amount**, **take-lane delete**, and **metronome volume**. These are +GUI-only in Live. (See issue #3.) ## Examples diff --git a/scripts/windows/run_smoke_test.ps1 b/scripts/windows/run_smoke_test.ps1 index a705ffb..7a2653f 100644 --- a/scripts/windows/run_smoke_test.ps1 +++ b/scripts/windows/run_smoke_test.ps1 @@ -1,6 +1,6 @@ param( [string]$RepoRoot = (Resolve-Path (Join-Path $PSScriptRoot "..\..")).Path, - [string]$Host = "127.0.0.1", + [string]$TargetHost = "127.0.0.1", [int]$Port = 9004, [string]$PythonLauncher = "py", [string]$LogFile = "" @@ -30,7 +30,7 @@ Get-NetTCPConnection -LocalPort $Port -ErrorAction SilentlyContinue | Write-Host "" Write-Host "Running smoke test client..." -& $PythonLauncher -3 $clientPath --host $Host --port $Port --log-file $LogFile +& $PythonLauncher -3 $clientPath --host $TargetHost --port $Port --log-file $LogFile Write-Host "" Write-Host "Raw request/response capture saved to $LogFile"