davinci-resolve-mcp 2.57.0 → 2.57.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.md CHANGED
@@ -69,6 +69,10 @@ semantics.
69
69
  - Release checklist and validation rules: `docs/process/release-process.md`
70
70
  - Kernel workflow support maps: `docs/kernels/`
71
71
  - API coverage and live-test status: `docs/reference/api-coverage.md`
72
+ - Blackmagic-facing API gaps/bugs (generated from `api_truth`):
73
+ `docs/reference/api-limitations.md` — when you document a new Resolve API
74
+ limitation, add a `submit`-tagged entry to `src/utils/api_truth.py` and
75
+ regenerate with `scripts/gen_api_limitations.py` (a drift guard enforces it)
72
76
  - Bundled Resolve API text: `docs/reference/resolve_scripting_api.txt`
73
77
 
74
78
  ## Key Paths
package/CHANGELOG.md CHANGED
@@ -2,6 +2,47 @@
2
2
 
3
3
  Release history for the DaVinci Resolve MCP Server. The latest release is summarized in the root README; older entries live here to keep the README focused.
4
4
 
5
+ ## What's New in v2.57.2
6
+
7
+ Consolidated, submittable list of Resolve scripting-API limitations.
8
+
9
+ - **Added** `docs/reference/api-limitations.md` — a curated, behaviorally-verified
10
+ catalogue of Resolve scripting-API gaps and bugs, split into **Missing
11
+ Capabilities** (please add) and **Bugs / Unreliable Behavior** (please fix),
12
+ formatted for submission to Blackmagic Design's developer feedback. First cut:
13
+ 6 missing capabilities (Source Track Selector / insert `trackIndex`, per-clip
14
+ audio stereo↔mono, native multicam-clip creation, transition create/copy,
15
+ `GetTimelineByName`, cloud project list/export/user management) and 9
16
+ bugs/unreliable behaviors (enum-key silent failures in `AutoSyncAudio`,
17
+ `CreateSubtitlesFromAudio`, CloudProject family, and `Timeline.Export`; flaky
18
+ `DeleteProject`; `Composition.Paste` bridge failure; `FlowView` unreliable
19
+ returns; truncated `Transcription` property; automation-blocking `CreateProject`
20
+ modal).
21
+ - **Added** `scripts/gen_api_limitations.py` — the report is generated from the
22
+ `submit`-tagged entries in the `api_truth` ledger (single source of truth, also
23
+ queryable at runtime via `resolve_control api_truth`), so it never drifts.
24
+ - **Changed** the release process and CI to keep it current: a new
25
+ `tests.test_api_limitations_doc` drift guard (added to the publish workflow)
26
+ fails if the doc is stale, and `docs/process/release-process.md` now requires
27
+ regenerating it whenever a `submit`-tagged entry changes.
28
+
29
+ ## What's New in v2.57.1
30
+
31
+ Investigation outcome for community feature request #74 — no behavior change.
32
+
33
+ - **Note** (issue #74) the DaVinci Resolve scripting API does not expose the
34
+ Source/Auto Track Selector, so there is no way to choose the destination track
35
+ when inserting Text+/titles/generators. Verified live on Resolve Studio 21.0.0:
36
+ no get/set for the selector exists; the `Insert*IntoTimeline` family takes no
37
+ `trackIndex` and always lands on V1; locking lower tracks makes the insert fail
38
+ rather than redirect; and titles/generators can't be relocated afterward (no
39
+ `MediaPoolItem`). Closed as won't-fix (API limitation).
40
+ - **Documentation** recorded the limitation in the verified `api_truth` ledger
41
+ (query at runtime with `resolve_control api_truth "track"`) and in
42
+ `docs/reference/api-coverage.md`, with the supported alternative for
43
+ media-backed clips (`MediaPool.AppendToTimeline` clipInfo `trackIndex`, exposed
44
+ as `media_pool.append_to_timeline` `clip_infos`). Added a regression test.
45
+
5
46
  ## What's New in v2.57.0
6
47
 
7
48
  Community feature requests #72 and #73.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # DaVinci Resolve MCP Server
2
2
 
3
- [![Version](https://img.shields.io/badge/version-2.57.0-blue.svg)](https://github.com/samuelgursky/davinci-resolve-mcp/releases)
3
+ [![Version](https://img.shields.io/badge/version-2.57.2-blue.svg)](https://github.com/samuelgursky/davinci-resolve-mcp/releases)
4
4
  [![npm](https://img.shields.io/npm/v/davinci-resolve-mcp.svg?label=npm&color=CB3837)](https://www.npmjs.com/package/davinci-resolve-mcp)
5
5
  [![API Coverage](https://img.shields.io/badge/API%20Coverage-100%25-brightgreen.svg)](docs/reference/api-coverage.md)
6
6
  [![Tools](https://img.shields.io/badge/MCP%20Tools-34%20(341%20full)-blue.svg)](#server-modes)
@@ -168,3 +168,6 @@ Samuel Gursky (samgursky@gmail.com)
168
168
 
169
169
  - [@rgxdev](https://github.com/rgxdev) — configurable Media Pool inventory walk
170
170
  (exclude bins + inventory limit), [#69](https://github.com/samuelgursky/davinci-resolve-mcp/pull/69) (v2.53.0)
171
+ - [@swayll](https://github.com/swayll) — Source Track Selector investigation
172
+ ([#74](https://github.com/samuelgursky/davinci-resolve-mcp/issues/74)); confirmed
173
+ + documented API limitation (v2.57.1)
@@ -29,6 +29,11 @@ Every release bump must update all version surfaces:
29
29
  - README version badge
30
30
  - README current stats or latest-release summary when they changed
31
31
  - `CHANGELOG.md` latest release entry
32
+ - `docs/reference/api-limitations.md` when any `submit`-tagged entry in
33
+ `src/utils/api_truth.py` was added or changed (a newly documented Resolve API
34
+ gap/bug, a closed won't-fix issue, etc.). Regenerate it — do not hand-edit:
35
+ `venv/bin/python scripts/gen_api_limitations.py`. The
36
+ `tests.test_api_limitations_doc` drift guard fails the suite if it is stale.
32
37
  - `docs/SKILL.md` when tool discovery, examples, or behavior changed
33
38
  - `docs/guides/control-panel.md` when the control panel UI changed, plus
34
39
  regenerated screenshots: start the panel against a project with analysis
@@ -48,6 +53,7 @@ Always run static checks before release:
48
53
  ```bash
49
54
  venv/bin/python tests/test_import.py
50
55
  venv/bin/python scripts/audit_api_parity.py
56
+ venv/bin/python scripts/gen_api_limitations.py --check
51
57
  venv/bin/python -m unittest tests.test_static_undefined_names tests.test_action_list_drift tests.test_panel_docs_drift
52
58
  node bin/davinci-resolve-mcp.mjs --help
53
59
  node bin/davinci-resolve-mcp.mjs --version
@@ -86,6 +92,17 @@ env RESOLVE_SCRIPT_API="/Library/Application Support/Blackmagic Design/DaVinci R
86
92
  venv/bin/python tests/live_v233_validation.py
87
93
  ```
88
94
 
95
+ For Fusion comp changes (masks, Text+/title text), run the issue #73 harness,
96
+ which creates a disposable Fusion-title project, exercises `add_fusion_mask` and
97
+ `set_text_plus` / `get_text_plus`, and deletes the project:
98
+
99
+ ```bash
100
+ env RESOLVE_SCRIPT_API="/Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting" \
101
+ RESOLVE_SCRIPT_LIB="/Applications/DaVinci Resolve/DaVinci Resolve.app/Contents/Libraries/Fusion/fusionscript.so" \
102
+ PYTHONPATH="/Library/Application Support/Blackmagic Design/DaVinci Resolve/Developer/Scripting/Modules" \
103
+ venv/bin/python tests/live_fusion_mask_title_validation.py
104
+ ```
105
+
89
106
  One-off live harnesses are acceptable during review, but reusable coverage
90
107
  should live under `tests/`. Do not commit generated media or disposable project
91
108
  artifacts.
@@ -44,6 +44,25 @@ maps `shot_descriptions[shot_index]` onto Media Pool shot markers, and triggers
44
44
  metadata writeback for that clip. Works with any MCP client whose chat model
45
45
  is vision-capable; no `sampling/createMessage` support required.
46
46
 
47
+ Some Edit-page behavior is simply not reachable through public scripting. The
48
+ **Source/Auto Track Selector** (the patch panel that chooses which video track a
49
+ clip lands on) has no get/set in the API, and the `Insert*IntoTimeline` family
50
+ (titles, generators, OFX, Fusion comps) takes no `trackIndex` — they always drop
51
+ onto the selector's current target (V1 in practice). Locking lower tracks does
52
+ not redirect the insert; it just makes the insert fail. Titles and generators
53
+ can't be relocated afterward either, since they have no `MediaPoolItem` for
54
+ `AppendToTimeline`/`MoveClips` to act on. For media-backed clips you *can* target
55
+ a track via `MediaPool.AppendToTimeline`'s clipInfo `trackIndex` (exposed as
56
+ `media_pool.append_to_timeline` with `clip_infos`). This limitation is recorded
57
+ in the verified `api_truth` ledger (query `resolve_control api_truth "track"`);
58
+ see issue #74.
59
+
60
+ The full catalogue of verified scripting-API gaps and bugs — curated for
61
+ submission to Blackmagic Design's developer feedback — lives in
62
+ [api-limitations.md](api-limitations.md). It is generated from the `submit`-tagged
63
+ `api_truth` entries (`scripts/gen_api_limitations.py`) and kept in sync by a drift
64
+ guard, so it never goes stale.
65
+
47
66
  | Class | Methods | Tools | Description |
48
67
  |-------|---------|-------|-------------|
49
68
  | Resolve | 22 | 22 | App control, pages, layout presets, render/burn-in presets, keyframe mode |
@@ -0,0 +1,141 @@
1
+ # DaVinci Resolve Scripting API — Limitations & Feedback
2
+
3
+ <!-- GENERATED FILE — do not edit by hand.
4
+ Source: src/utils/api_truth.py (entries tagged `submit`).
5
+ Regenerate: venv/bin/python scripts/gen_api_limitations.py -->
6
+
7
+ This is a curated, behaviorally-verified list of DaVinci Resolve scripting
8
+ API gaps and bugs encountered while building this MCP server, intended for
9
+ submission to Blackmagic Design's developer feedback. Every item was
10
+ observed against live Resolve; each entry notes the current workaround (or
11
+ that none exists).
12
+
13
+ **Verified on:** DaVinci Resolve Studio 21.0.0
14
+
15
+ **Totals:** 6 missing capabilities, 9 bugs / unreliable behaviors.
16
+
17
+ The authoritative source is the runtime-queryable `api_truth` ledger
18
+ (`resolve_control api_truth "<query>"`); this document is generated from
19
+ it and stays in sync via a drift guard.
20
+
21
+ ## Missing Capabilities (please add)
22
+
23
+ Functionality that exists in the Resolve UI but has no scripting API
24
+ equivalent, blocking full automation.
25
+
26
+ ### Timeline.GetTimelineByName
27
+
28
+ - **Object:** `Project`
29
+ - **Behavior:** Does not exist. Timelines are looked up by index.
30
+ - **Workaround / current handling:** Iterate GetTimelineByIndex(1..GetTimelineCount()).
31
+ - **Tags:** missing-method, timeline
32
+
33
+ ### Source Track Selector / destination track for Insert*IntoTimeline
34
+
35
+ - **Object:** `Timeline`
36
+ - **Behavior:** There is no API to read or set the Source/Auto Track Selector (the Edit-page patch panel that picks the destination track). InsertTitleIntoTimeline, InsertFusionTitleIntoTimeline, InsertGeneratorIntoTimeline, InsertFusionGeneratorIntoTimeline, InsertOFXGeneratorIntoTimeline and InsertFusionCompositionIntoTimeline take no trackIndex and always drop the clip on the selector's current target (V1 in practice). Locking lower video tracks does NOT redirect the insert — verified live on 21.0.0: locking V1 makes the insert FAIL rather than land on V2. Titles/generators also can't be moved afterward (no MediaPoolItem, so AppendToTimeline clipInfo and MoveClips don't apply).
37
+ - **Workaround / current handling:** Accept the limitation for titles/generators (insert lands on V1). For clips that DO have a MediaPoolItem, target a track with MediaPool.AppendToTimeline's clipInfo 'trackIndex' instead (exposed as media_pool append_to_timeline clip_infos). See issue #74.
38
+ - **Reference:** [issue #74](https://github.com/samuelgursky/davinci-resolve-mcp/issues/74)
39
+ - **Tags:** missing-method, timeline, title, generator, track
40
+
41
+ ### Per-clip audio channel-format conversion (Stereo<->Mono)
42
+
43
+ - **Object:** `MediaPoolItem / TimelineItem`
44
+ - **Behavior:** No scripting method converts an individual clip's audio channel format. ConvertTimelineToStereo is timeline-wide, and CreateStereoClip builds a 3D *visual* stereoscopic clip, not an audio mono->stereo change. The Edit-page 'Clip Attributes > Audio' channel mapping is UI-only.
45
+ - **Workaround / current handling:** Use the supported surface: timeline add_track with audioType (create mono/stereo tracks), get_track_sub_type (query format), convert_to_stereo (timeline-wide), and timeline_item get_source_audio_channel_mapping. Per-clip conversion is not possible. See issue #73.
46
+ - **Reference:** [issue #73](https://github.com/samuelgursky/davinci-resolve-mcp/issues/73)
47
+ - **Tags:** missing-method, audio, channel
48
+
49
+ ### Native multicam clip creation
50
+
51
+ - **Object:** `MediaPool`
52
+ - **Behavior:** There is no method to create a native multicam clip from a set of angles. Angles can be stacked onto tracks programmatically, but the multicam-clip conversion is a UI-only step.
53
+ - **Workaround / current handling:** Prepare a stacked timeline (media_pool setup_multicam_timeline) and finish the multicam-clip conversion in the Resolve UI.
54
+ - **Tags:** missing-method, media-pool, multicam
55
+
56
+ ### Transition create / copy / clone
57
+
58
+ - **Object:** `Timeline / TimelineItem`
59
+ - **Behavior:** The scripting API exposes no method to add, read, copy, or clone an edit transition (cross-dissolve, etc.). Transitions applied in the UI are invisible to and unmodifiable by scripts.
60
+ - **Workaround / current handling:** Apply/duplicate transitions in the Resolve UI; no scripted equivalent exists.
61
+ - **Tags:** missing-method, timeline, transition
62
+
63
+ ### Cloud project enumeration / export / user management
64
+
65
+ - **Object:** `ProjectManager`
66
+ - **Behavior:** Only CreateCloudProject, LoadCloudProject, ImportCloudProject and RestoreCloudProject exist. There is no GetCloudProjectList (list available cloud projects), no ExportToCloud, and no Add/RemoveUserToCloudProject — so cloud collaboration can't be fully automated.
67
+ - **Workaround / current handling:** Drive cloud project listing, export, and collaborator management from the Resolve UI; only create/load/import/restore are scriptable.
68
+ - **Tags:** missing-method, project, cloud
69
+
70
+ ## Bugs / Unreliable Behavior (please fix)
71
+
72
+ Methods that exist but misbehave — silent failures, unreliable return
73
+ values, or automation-hostile modal prompts.
74
+
75
+ ### MediaPool.AutoSyncAudio
76
+
77
+ - **Object:** `MediaPool`
78
+ - **Signature:** `(clips, settings) -> bool`
79
+ - **Behavior:** The boolean return does not reflect whether clips actually linked, and string enum keys in `settings` are silently rejected (the call returns False).
80
+ - **Workaround / current handling:** Resolve the AUDIO_SYNC_* enum constants via the live resolve handle, and verify by reading each clip's 'Synced Audio' property (see verify_by_readback).
81
+ - **Tags:** unreliable-return, silent-failure, audio, enum
82
+
83
+ ### Timeline.CreateSubtitlesFromAudio
84
+
85
+ - **Object:** `Timeline`
86
+ - **Signature:** `(autoCaptionSettings) -> bool`
87
+ - **Behavior:** Same failure mode as AutoSyncAudio: the autoCaptionSettings dict is keyed by resolve.SUBTITLE_* enum constants with resolve.AUTO_CAPTION_* enum values, so plain string keys like {'language': 'korean'} are silently rejected (returns False, no subtitle track created). The boolean is also unreliable.
88
+ - **Workaround / current handling:** Resolve the SUBTITLE_*/AUTO_CAPTION_* constants via the live resolve handle (server._normalize_auto_caption_settings) and verify by reading the timeline's subtitle track count before/after (server._safe_create_subtitles).
89
+ - **Tags:** unreliable-return, silent-failure, subtitle, enum
90
+
91
+ ### ProjectManager CloudProject family (Create/Load/Import/RestoreCloudProject)
92
+
93
+ - **Object:** `ProjectManager`
94
+ - **Signature:** `(..., cloudSettings) -> Project | bool`
95
+ - **Behavior:** All four take an enum-keyed {cloudSettings} dict (resolve.CLOUD_SETTING_* keys, resolve.CLOUD_SYNC_* sync-mode values). Plain string keys are silently rejected, so a settings dict built from human-readable keys yields no project / False.
96
+ - **Workaround / current handling:** Resolve the CLOUD_SETTING_*/CLOUD_SYNC_* constants via the live resolve handle (server._normalize_cloud_settings) before calling, and treat the bool return from Import/RestoreCloudProject as advisory.
97
+ - **Tags:** silent-failure, project, cloud, enum
98
+
99
+ ### Timeline.Export
100
+
101
+ - **Object:** `Timeline`
102
+ - **Signature:** `(fileName, exportType, exportSubtype) -> bool`
103
+ - **Behavior:** exportType/exportSubtype must be resolve.EXPORT_* enum *values* resolved from the live handle. A JSON/MCP caller cannot pass a live enum, and a plain string ('fcpxml', or even the constant name 'EXPORT_FCPXML_1_10') is silently rejected with no file written.
104
+ - **Workaround / current handling:** Map a friendly format/subtype to the EXPORT_* constant and resolve it against the live handle (server._timeline_export_spec) before calling; verify the output file exists afterward.
105
+ - **Tags:** silent-failure, timeline, export, enum
106
+
107
+ ### ProjectManager.DeleteProject
108
+
109
+ - **Object:** `ProjectManager`
110
+ - **Signature:** `(projectName) -> bool`
111
+ - **Behavior:** Returns False (no deletion) when the target project is, or recently was, the current project, and is flaky on the first attempt — so a single bool() call leaves the project undeleted with no useful error.
112
+ - **Workaround / current handling:** Load/close away from the target first, then retry; use src/utils/project_cleanup.py:delete_project_safely.
113
+ - **Tags:** unreliable-return, project, flaky
114
+
115
+ ### Composition.Paste
116
+
117
+ - **Object:** `Fusion Composition`
118
+ - **Behavior:** Passing tool.SaveSettings()'s in-memory table to Paste() / LoadSettings() fails across the Python bridge with an OrderedDict/null-argument error and creates no node, while reporting nothing useful.
119
+ - **Workaround / current handling:** Duplicate via AddTool(RegID) + SaveSettings(path)/LoadSettings(path) through a temp .setting FILE, which round-trips reliably. Identify the new node by name diff.
120
+ - **Tags:** fusion, bridge, silent-failure
121
+
122
+ ### FlowView.SetPos / FlowView.GetPosTable
123
+
124
+ - **Object:** `Fusion FlowView (comp.CurrentFrame.FlowView)`
125
+ - **Behavior:** Node positions are read/written through the FlowView, not the tool. SetPos returns nothing reliable; GetPosTable returns a 1-indexed table (or dict/tuple depending on bridge).
126
+ - **Workaround / current handling:** Use comp.CurrentFrame.FlowView.SetPos(tool, x, y); confirm with GetPosTable and a liberal position parser.
127
+ - **Tags:** fusion, unreliable-return
128
+
129
+ ### MediaPoolItem.GetClipProperty('Transcription')
130
+
131
+ - **Object:** `MediaPoolItem`
132
+ - **Behavior:** Returns a PREVIEW of the transcription that ends in an ellipsis when the full transcript is longer than the property exposes.
133
+ - **Workaround / current handling:** Treat a trailing ellipsis as truncation (see media_pool_item get_transcription's `truncated` flag).
134
+ - **Tags:** transcription, truncation
135
+
136
+ ### ProjectManager.CreateProject (with a dirty Untitled project)
137
+
138
+ - **Object:** `ProjectManager`
139
+ - **Behavior:** Returns None and pops a modal 'Save Current Project' dialog when the current unsaved/Untitled project blocks the switch. SaveProject() on an Untitled project re-triggers the same modal.
140
+ - **Workaround / current handling:** CloseProject(current) to discard the untitled project without a prompt, then CreateProject; restore with LoadProject afterward.
141
+ - **Tags:** project, modal, silent-failure
package/install.py CHANGED
@@ -35,7 +35,7 @@ from src.utils.update_check import (
35
35
 
36
36
  # ─── Version ──────────────────────────────────────────────────────────────────
37
37
 
38
- VERSION = "2.57.0"
38
+ VERSION = "2.57.2"
39
39
  # Only hard floor: mcp[cli] requires Python 3.10+. There is no upper bound —
40
40
  # Resolve's scripting bridge loads into newer interpreters on recent builds
41
41
  # (Python 3.14 verified against Resolve Studio 20.3.2). Older Resolve builds
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "davinci-resolve-mcp",
3
- "version": "2.57.0",
3
+ "version": "2.57.2",
4
4
  "description": "NPM bootstrapper for the DaVinci Resolve MCP Server.",
5
5
  "license": "MIT",
6
6
  "author": "Samuel Gursky <samgursky@gmail.com>",
@@ -0,0 +1,126 @@
1
+ #!/usr/bin/env python3
2
+ """Generate the Blackmagic-facing DaVinci Resolve API limitations report.
3
+
4
+ The single source of truth is the ``submit``-tagged entries in
5
+ ``src/utils/api_truth.py`` (see ``submittable_limitations``). This script renders
6
+ them into ``docs/reference/api-limitations.md`` — a curated, behaviorally-verified
7
+ list that can be submitted to Blackmagic Design's developer feedback, split into
8
+ capabilities they should *add* and behaviors they should *fix*.
9
+
10
+ The output is deterministic (no timestamps) so ``tests.test_api_limitations_doc``
11
+ can assert the committed file matches. Regenerate after editing any ``submit``
12
+ entry:
13
+
14
+ venv/bin/python scripts/gen_api_limitations.py
15
+
16
+ Run with ``--check`` to fail (exit 1) when the committed doc is stale.
17
+ """
18
+ from __future__ import annotations
19
+
20
+ import sys
21
+ from pathlib import Path
22
+
23
+ REPO_ROOT = Path(__file__).resolve().parent.parent
24
+ if str(REPO_ROOT) not in sys.path:
25
+ sys.path.insert(0, str(REPO_ROOT))
26
+
27
+ from src.utils.api_truth import ( # noqa: E402
28
+ VERIFIED_ON,
29
+ submittable_limitations,
30
+ )
31
+
32
+ DOC_PATH = REPO_ROOT / "docs" / "reference" / "api-limitations.md"
33
+ ISSUE_URL = "https://github.com/samuelgursky/davinci-resolve-mcp/issues"
34
+
35
+
36
+ def _render_entry(entry: dict) -> str:
37
+ lines = [f"### {entry['symbol']}", ""]
38
+ obj = entry.get("object")
39
+ if obj:
40
+ lines.append(f"- **Object:** `{obj}`")
41
+ sig = entry.get("signature")
42
+ if sig:
43
+ lines.append(f"- **Signature:** `{sig}`")
44
+ lines.append(f"- **Behavior:** {entry['reality']}")
45
+ rec = entry.get("recommended")
46
+ if rec:
47
+ lines.append(f"- **Workaround / current handling:** {rec}")
48
+ issue = entry.get("issue")
49
+ if issue is not None:
50
+ lines.append(f"- **Reference:** [issue #{issue}]({ISSUE_URL}/{issue})")
51
+ tags = entry.get("tags")
52
+ if tags:
53
+ lines.append(f"- **Tags:** {', '.join(tags)}")
54
+ lines.append("")
55
+ return "\n".join(lines)
56
+
57
+
58
+ def render() -> str:
59
+ groups = submittable_limitations()
60
+ missing = groups["missing"]
61
+ bugs = groups["bug"]
62
+
63
+ out = [
64
+ "# DaVinci Resolve Scripting API — Limitations & Feedback",
65
+ "",
66
+ "<!-- GENERATED FILE — do not edit by hand.",
67
+ " Source: src/utils/api_truth.py (entries tagged `submit`).",
68
+ " Regenerate: venv/bin/python scripts/gen_api_limitations.py -->",
69
+ "",
70
+ "This is a curated, behaviorally-verified list of DaVinci Resolve scripting",
71
+ "API gaps and bugs encountered while building this MCP server, intended for",
72
+ "submission to Blackmagic Design's developer feedback. Every item was",
73
+ "observed against live Resolve; each entry notes the current workaround (or",
74
+ "that none exists).",
75
+ "",
76
+ f"**Verified on:** {VERIFIED_ON}",
77
+ "",
78
+ f"**Totals:** {len(missing)} missing capabilities, {len(bugs)} bugs / "
79
+ "unreliable behaviors.",
80
+ "",
81
+ "The authoritative source is the runtime-queryable `api_truth` ledger",
82
+ "(`resolve_control api_truth \"<query>\"`); this document is generated from",
83
+ "it and stays in sync via a drift guard.",
84
+ "",
85
+ "## Missing Capabilities (please add)",
86
+ "",
87
+ "Functionality that exists in the Resolve UI but has no scripting API",
88
+ "equivalent, blocking full automation.",
89
+ "",
90
+ ]
91
+ for entry in missing:
92
+ out.append(_render_entry(entry))
93
+
94
+ out += [
95
+ "## Bugs / Unreliable Behavior (please fix)",
96
+ "",
97
+ "Methods that exist but misbehave — silent failures, unreliable return",
98
+ "values, or automation-hostile modal prompts.",
99
+ "",
100
+ ]
101
+ for entry in bugs:
102
+ out.append(_render_entry(entry))
103
+
104
+ return "\n".join(out).rstrip() + "\n"
105
+
106
+
107
+ def main(argv: list[str]) -> int:
108
+ content = render()
109
+ if "--check" in argv:
110
+ current = DOC_PATH.read_text() if DOC_PATH.exists() else ""
111
+ if current != content:
112
+ print(
113
+ f"STALE: {DOC_PATH.relative_to(REPO_ROOT)} is out of date.\n"
114
+ "Run: venv/bin/python scripts/gen_api_limitations.py",
115
+ file=sys.stderr,
116
+ )
117
+ return 1
118
+ print(f"OK: {DOC_PATH.relative_to(REPO_ROOT)} is up to date.")
119
+ return 0
120
+ DOC_PATH.write_text(content)
121
+ print(f"Wrote {DOC_PATH.relative_to(REPO_ROOT)}")
122
+ return 0
123
+
124
+
125
+ if __name__ == "__main__":
126
+ raise SystemExit(main(sys.argv[1:]))
@@ -80,7 +80,7 @@ if not logging.getLogger().handlers:
80
80
  handlers=[logging.StreamHandler()],
81
81
  )
82
82
 
83
- VERSION = "2.57.0"
83
+ VERSION = "2.57.2"
84
84
  logger = logging.getLogger("davinci-resolve-mcp")
85
85
  logger.info(f"Starting DaVinci Resolve MCP Server v{VERSION}")
86
86
  logger.info(f"Detected platform: {get_platform()}")
package/src/server.py CHANGED
@@ -11,7 +11,7 @@ Usage:
11
11
  python src/server.py --full # Start the 341-tool granular server instead
12
12
  """
13
13
 
14
- VERSION = "2.57.0"
14
+ VERSION = "2.57.2"
15
15
 
16
16
  import base64
17
17
  import os
@@ -10,6 +10,19 @@ Each entry is a small dict. Grow it opportunistically — every readback recipe
10
10
  every fix that uncovers a surprising behavior should add an entry. Facts are
11
11
  stamped with the Resolve build they were verified on so drift is visible when a
12
12
  new version ships.
13
+
14
+ Optional keys on an entry feed the Blackmagic-facing limitations report
15
+ (``docs/reference/api-limitations.md``, generated by
16
+ ``scripts/gen_api_limitations.py``):
17
+
18
+ - ``submit``: ``"missing"`` (a capability Blackmagic should add) or ``"bug"``
19
+ (a behavior Blackmagic should fix). Entries without ``submit`` are internal
20
+ quirks/tips and stay out of the report.
21
+ - ``issue``: GitHub issue number (int) that drove the finding, for cross-ref.
22
+
23
+ When you add or change a ``submit``-tagged entry, regenerate the report
24
+ (``venv/bin/python scripts/gen_api_limitations.py``) or the
25
+ ``tests.test_api_limitations_doc`` drift guard fails.
13
26
  """
14
27
  from typing import Any, Dict, List, Optional
15
28
 
@@ -28,6 +41,7 @@ API_TRUTH: List[Dict[str, Any]] = [
28
41
  "resolve handle, and verify by reading each clip's "
29
42
  "'Synced Audio' property (see verify_by_readback).",
30
43
  "tags": ["unreliable-return", "silent-failure", "audio", "enum"],
44
+ "submit": "bug",
31
45
  "mitigation": ["_normalize_auto_sync_settings", "_safe_auto_sync_audio"],
32
46
  },
33
47
  {
@@ -44,6 +58,7 @@ API_TRUTH: List[Dict[str, Any]] = [
44
58
  "and verify by reading the timeline's subtitle track count "
45
59
  "before/after (server._safe_create_subtitles).",
46
60
  "tags": ["unreliable-return", "silent-failure", "subtitle", "enum"],
61
+ "submit": "bug",
47
62
  "mitigation": ["_normalize_auto_caption_settings", "_safe_create_subtitles"],
48
63
  },
49
64
  {
@@ -59,6 +74,7 @@ API_TRUTH: List[Dict[str, Any]] = [
59
74
  "before calling, and treat the bool return from "
60
75
  "Import/RestoreCloudProject as advisory.",
61
76
  "tags": ["silent-failure", "project", "cloud", "enum"],
77
+ "submit": "bug",
62
78
  "mitigation": ["_normalize_cloud_settings"],
63
79
  },
64
80
  {
@@ -75,6 +91,7 @@ API_TRUTH: List[Dict[str, Any]] = [
75
91
  "(server._timeline_export_spec) before calling; verify the "
76
92
  "output file exists afterward.",
77
93
  "tags": ["silent-failure", "timeline", "export", "enum"],
94
+ "submit": "bug",
78
95
  "mitigation": ["_timeline_export_spec", "_timeline_export_value"],
79
96
  },
80
97
  {
@@ -88,6 +105,7 @@ API_TRUTH: List[Dict[str, Any]] = [
88
105
  "recommended": "Load/close away from the target first, then retry; use "
89
106
  "src/utils/project_cleanup.py:delete_project_safely.",
90
107
  "tags": ["unreliable-return", "project", "flaky"],
108
+ "submit": "bug",
91
109
  },
92
110
  {
93
111
  "symbol": "Composition.Paste",
@@ -100,6 +118,7 @@ API_TRUTH: List[Dict[str, Any]] = [
100
118
  "LoadSettings(path) through a temp .setting FILE, which "
101
119
  "round-trips reliably. Identify the new node by name diff.",
102
120
  "tags": ["fusion", "bridge", "silent-failure"],
121
+ "submit": "bug",
103
122
  },
104
123
  {
105
124
  "symbol": "FlowView.SetPos / FlowView.GetPosTable",
@@ -110,6 +129,7 @@ API_TRUTH: List[Dict[str, Any]] = [
110
129
  "recommended": "Use comp.CurrentFrame.FlowView.SetPos(tool, x, y); confirm "
111
130
  "with GetPosTable and a liberal position parser.",
112
131
  "tags": ["fusion", "unreliable-return"],
132
+ "submit": "bug",
113
133
  },
114
134
  {
115
135
  "symbol": "Timeline.GetTimelineByName",
@@ -117,6 +137,7 @@ API_TRUTH: List[Dict[str, Any]] = [
117
137
  "reality": "Does not exist. Timelines are looked up by index.",
118
138
  "recommended": "Iterate GetTimelineByIndex(1..GetTimelineCount()).",
119
139
  "tags": ["missing-method", "timeline"],
140
+ "submit": "missing",
120
141
  },
121
142
  {
122
143
  "symbol": "Project render methods (AddRenderJob, SetRenderSettings, ...)",
@@ -136,6 +157,7 @@ API_TRUTH: List[Dict[str, Any]] = [
136
157
  "recommended": "Treat a trailing ellipsis as truncation (see "
137
158
  "media_pool_item get_transcription's `truncated` flag).",
138
159
  "tags": ["transcription", "truncation"],
160
+ "submit": "bug",
139
161
  },
140
162
  {
141
163
  "symbol": "ProjectManager.CreateProject (with a dirty Untitled project)",
@@ -147,6 +169,7 @@ API_TRUTH: List[Dict[str, Any]] = [
147
169
  "without a prompt, then CreateProject; restore with "
148
170
  "LoadProject afterward.",
149
171
  "tags": ["project", "modal", "silent-failure"],
172
+ "submit": "bug",
150
173
  },
151
174
  {
152
175
  "symbol": "Timeline.InsertFusionCompositionIntoTimeline",
@@ -158,6 +181,83 @@ API_TRUTH: List[Dict[str, Any]] = [
158
181
  "need a comp to operate on.",
159
182
  "tags": ["fusion", "timeline"],
160
183
  },
184
+ {
185
+ "symbol": "Source Track Selector / destination track for Insert*IntoTimeline",
186
+ "object": "Timeline",
187
+ "reality": "There is no API to read or set the Source/Auto Track Selector "
188
+ "(the Edit-page patch panel that picks the destination track). "
189
+ "InsertTitleIntoTimeline, InsertFusionTitleIntoTimeline, "
190
+ "InsertGeneratorIntoTimeline, InsertFusionGeneratorIntoTimeline, "
191
+ "InsertOFXGeneratorIntoTimeline and "
192
+ "InsertFusionCompositionIntoTimeline take no trackIndex and "
193
+ "always drop the clip on the selector's current target (V1 in "
194
+ "practice). Locking lower video tracks does NOT redirect the "
195
+ "insert — verified live on 21.0.0: locking V1 makes the insert "
196
+ "FAIL rather than land on V2. Titles/generators also can't be "
197
+ "moved afterward (no MediaPoolItem, so AppendToTimeline clipInfo "
198
+ "and MoveClips don't apply).",
199
+ "recommended": "Accept the limitation for titles/generators (insert lands "
200
+ "on V1). For clips that DO have a MediaPoolItem, target a "
201
+ "track with MediaPool.AppendToTimeline's clipInfo 'trackIndex' "
202
+ "instead (exposed as media_pool append_to_timeline clip_infos). "
203
+ "See issue #74.",
204
+ "tags": ["missing-method", "timeline", "title", "generator", "track"],
205
+ "submit": "missing",
206
+ "issue": 74,
207
+ },
208
+ {
209
+ "symbol": "Per-clip audio channel-format conversion (Stereo<->Mono)",
210
+ "object": "MediaPoolItem / TimelineItem",
211
+ "reality": "No scripting method converts an individual clip's audio "
212
+ "channel format. ConvertTimelineToStereo is timeline-wide, and "
213
+ "CreateStereoClip builds a 3D *visual* stereoscopic clip, not an "
214
+ "audio mono->stereo change. The Edit-page 'Clip Attributes > "
215
+ "Audio' channel mapping is UI-only.",
216
+ "recommended": "Use the supported surface: timeline add_track with audioType "
217
+ "(create mono/stereo tracks), get_track_sub_type (query "
218
+ "format), convert_to_stereo (timeline-wide), and "
219
+ "timeline_item get_source_audio_channel_mapping. Per-clip "
220
+ "conversion is not possible. See issue #73.",
221
+ "tags": ["missing-method", "audio", "channel"],
222
+ "submit": "missing",
223
+ "issue": 73,
224
+ },
225
+ {
226
+ "symbol": "Native multicam clip creation",
227
+ "object": "MediaPool",
228
+ "reality": "There is no method to create a native multicam clip from a set "
229
+ "of angles. Angles can be stacked onto tracks programmatically, "
230
+ "but the multicam-clip conversion is a UI-only step.",
231
+ "recommended": "Prepare a stacked timeline (media_pool setup_multicam_timeline) "
232
+ "and finish the multicam-clip conversion in the Resolve UI.",
233
+ "tags": ["missing-method", "media-pool", "multicam"],
234
+ "submit": "missing",
235
+ },
236
+ {
237
+ "symbol": "Transition create / copy / clone",
238
+ "object": "Timeline / TimelineItem",
239
+ "reality": "The scripting API exposes no method to add, read, copy, or "
240
+ "clone an edit transition (cross-dissolve, etc.). Transitions "
241
+ "applied in the UI are invisible to and unmodifiable by scripts.",
242
+ "recommended": "Apply/duplicate transitions in the Resolve UI; no scripted "
243
+ "equivalent exists.",
244
+ "tags": ["missing-method", "timeline", "transition"],
245
+ "submit": "missing",
246
+ },
247
+ {
248
+ "symbol": "Cloud project enumeration / export / user management",
249
+ "object": "ProjectManager",
250
+ "reality": "Only CreateCloudProject, LoadCloudProject, ImportCloudProject "
251
+ "and RestoreCloudProject exist. There is no GetCloudProjectList "
252
+ "(list available cloud projects), no ExportToCloud, and no "
253
+ "Add/RemoveUserToCloudProject — so cloud collaboration can't be "
254
+ "fully automated.",
255
+ "recommended": "Drive cloud project listing, export, and collaborator "
256
+ "management from the Resolve UI; only create/load/import/"
257
+ "restore are scriptable.",
258
+ "tags": ["missing-method", "project", "cloud"],
259
+ "submit": "missing",
260
+ },
161
261
  {
162
262
  "symbol": "subprocess inheriting stdin under the MCP stdio server",
163
263
  "object": "(server runtime)",
@@ -190,3 +290,17 @@ def lookup_api_truth(query: Optional[str] = None) -> List[Dict[str, Any]]:
190
290
  if q in hay:
191
291
  out.append(e)
192
292
  return out
293
+
294
+
295
+ def submittable_limitations() -> Dict[str, List[Dict[str, Any]]]:
296
+ """Group ``submit``-tagged entries for the Blackmagic-facing report.
297
+
298
+ Returns ``{"missing": [...], "bug": [...]}`` — entries Blackmagic should add
299
+ vs. behaviors they should fix — preserving API_TRUTH order within each group.
300
+ """
301
+ groups: Dict[str, List[Dict[str, Any]]] = {"missing": [], "bug": []}
302
+ for e in API_TRUTH:
303
+ kind = e.get("submit")
304
+ if kind in groups:
305
+ groups[kind].append(e)
306
+ return groups