Skip to content

Commit 1af33a9

Browse files
docs: add comprehensive user guide and update API limitations in documentation and server messaging.
1 parent 88cbfeb commit 1af33a9

4 files changed

Lines changed: 498 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,11 @@ Full setup is below.
7878
- Tempo and key estimation from an audio file.
7979
- Melody-to-MIDI transcription (CREPE pitch tracking, with a lighter fallback).
8080

81-
The server exposes 117 tools across the production, mixing, composition, safety,
81+
The server exposes 138 tools across the production, mixing, composition, safety,
8282
and project-organization surface, plus 6 live resources (project, mixer,
8383
transport, channels, patterns, status) that the LLM assistant can read directly.
84+
For a user-facing value overview, workflow examples, and the full tool catalog,
85+
see [`docs/USER_GUIDE.md`](docs/USER_GUIDE.md).
8486

8587
## What sets it apart
8688

@@ -220,6 +222,9 @@ Plain-language prompts:
220222
- "Export this arrangement to a MIDI file."
221223
- "What tempo and key is this track?" (on an audio file)
222224

225+
For examples by module, assistant, and diagnostic check, see the
226+
[`User Guide`](docs/USER_GUIDE.md).
227+
223228
## Architecture
224229

225230
A thin controller script runs inside FL Studio and returns only cheap, raw data; all judgement — diagnosis, calibration, planning — happens server-side. A standalone daemon owns the MIDI port so the server works regardless of how the MCP client is launched. Note authoring uses a generated pyscript bridge: the daemon re-triggers the armed `MCP_Apply` script with a keystroke (via pyautogui) after a brief window force-focus. Every project-modifying tool routes through a snapshot → write → readback → rollback safety layer backed by a persisted change log.

ROADMAP.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ task.
2626

2727
## Current verification checkpoints
2828

29+
- 2026-06-02: User-facing value, workflow, and tool-reference documentation
30+
added.
31+
- Verified path: `docs/USER_GUIDE.md` reviewed against
32+
`scripts/audit_tool_safety.py --format json` output; README usage entry
33+
linked to the guide; stale pattern-creation limit language corrected in
34+
server instructions and this roadmap.
35+
- Result: public docs now explain the app's production value, natural-language
36+
assistant interaction model, module-level examples, MCP resources, safety
37+
classes, explicit product boundaries, and the current 138-tool catalog.
2938
- 2026-06-02: Fork provenance and repository metadata aligned with the
3039
maintained `thunderdew-dawn/flstudio-mcp` branch.
3140
- Verified path: README, CONTRIBUTING, package metadata, MCP server metadata,
@@ -759,8 +768,9 @@ gain, not 1.0. The tools accept dB and convert.
759768
- [x] `fl_arrange_add_marker` (previously implemented in arrangement slice) — Section markers.
760769

761770
API limits worth surfacing in tool docs:
762-
- New patterns cannot be created from scratch; clone an existing pattern
763-
instead (`fl_arrange_clone_pattern`).
771+
- Playlist clip placement, movement, and deletion remain out of scope; create
772+
or clone patterns, write notes into them, add markers, and place clips
773+
manually in FL Studio.
764774

765775
## Phase 4 — Piano Roll pyscript (~6 tools) [x] Completed
766776

0 commit comments

Comments
 (0)