deep-roon-mcp 0.0.0-stage → 0.1.0

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/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,10 @@
1
+ Deep Roon MCP
2
+ Copyright 2026 René Bouwmeester
3
+
4
+ This product is licensed under the Apache License, Version 2.0 (see LICENSE).
5
+
6
+ It includes the core of roon-api-reverse-engineering by Arthur Soares (MIT License, see src/intern/LICENSE), with the
7
+ changes listed in src/intern/README.md. The built bundle (dist/, and the .mcpb) also includes the packages listed with their
8
+ licences in THIRD_PARTY_LICENSES.txt — among them the MCP TypeScript SDK (MIT) and Roon Labs' node-roon-api (Apache-2.0).
9
+
10
+ Deep Roon MCP is not made, endorsed or supported by Roon Labs.
package/README.md CHANGED
@@ -1,3 +1,174 @@
1
- # Temporary Holding Version
1
+ # Deep Roon MCP
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The parts of Roon the official API doesn't reach, for Claude and any other MCP client: the reviews and biographies Roon
4
+ shows, search across your library and Qobuz at once, Qobuz's editorial shelves, album pages with credits, artist
5
+ discographies, and your own play history with real "most played" counts.
6
+
7
+ > **Read this first.** Deep Roon MCP is unofficial: it is not made, endorsed or supported by Roon Labs. It uses Roon's
8
+ > internal protocol — the one Roon's own apps use — through Arthur Soares'
9
+ > [roon-api-reverse-engineering](https://github.com/arthursoares/roon-api-reverse-engineering), which Roon Labs allows
10
+ > for tinkering with your own system. Brian Luczkiewicz (Roon Labs) on that protocol: it is *"not hardened for 3rd party
11
+ > use"*, it can change with any Roon update, and misuse can cause memory or compute leaks in the Core. Read
12
+ > [Arthur's thread on the Roon Community](https://community.roonlabs.com/t/reverse-engineering-the-roon-desktop-clients-local-protocol-typescript-client-docs/321731)
13
+ > before you use it.
14
+ >
15
+ > **Use it entirely at your own risk.** It comes without any warranty (see the licence). If your Core misbehaves, quit
16
+ > Deep Roon MCP and restart the Core. Report problems here, not to Roon's support. Keep port 9332 on your own network,
17
+ > never forward it to the internet. A Roon update can break a tool until Deep Roon MCP is updated. With the internal
18
+ > protocol switched off (see the settings below) only Roon's official extension API is used.
19
+
20
+ **What stays at home.** Deep Roon MCP runs on your computer and talks to your Roon Core over your own network. It has no
21
+ server of its own and sends nothing anywhere else. What you ask goes to your MCP client's model like any other question.
22
+
23
+ ## Status
24
+
25
+ Version 0.1: fifty tools.
26
+
27
+ **Reading** — changes nothing in Roon:
28
+
29
+ | Tool | What it does |
30
+ |---|---|
31
+ | `roon_search` | Your library and Qobuz at once: albums (with format), artists, tracks |
32
+ | `roon_new` | Qobuz's shelves: new, qobuzissimes, press awards, top, trending, ideal discography — by genre |
33
+ | `roon_genres` | Qobuz's genres and their ids |
34
+ | `roon_album` | An album's page: tracks, release dates, label, barcode, credits |
35
+ | `roon_review` | The review Roon shows, in full, with its author |
36
+ | `roon_bio` | The biography Roon shows, in full, with related artists |
37
+ | `roon_artist` | An artist's discography, oldest first |
38
+ | `roon_status` | How Deep Roon MCP stands: Core, pairing, internal protocol, self-test, newer version |
39
+ | `roon_zones` | Roon's zones and groups |
40
+ | `roon_now_playing` | What plays in each zone, with the volume |
41
+ | `roon_queue` | A zone's queue |
42
+ | `roon_cover` | The cover of what plays, as an image |
43
+ | `roon_history` | Roon's play history, newest first |
44
+ | `roon_top` | Most played albums, artists or tracks over your whole history |
45
+ | `roon_library` | Your library with Roon's Focus: stars, genre, label, artist, composer, producer, years, hi-res, live … sorted any way |
46
+ | `roon_focus` | The Focus panel: what your library (or part of it) is made of, with counts |
47
+ | `roon_tracks`, `roon_artists` | Focus on tracks and artists (and composers) |
48
+ | `roon_works`, `roon_work` | Compositions, and one work with its description and your recordings of it |
49
+ | `roon_daily_picks` | Today's Daily Picks from Roon's Home, with why |
50
+ | `roon_new_for_you` | New releases Roon picked for you |
51
+ | `roon_mixes` | Today's Daily Mixes |
52
+ | `roon_playlists`, `roon_playlist` | Your playlists, and one playlist's tracks |
53
+ | `roon_favorites` | Albums with a heart in Roon, or your Qobuz favourites |
54
+ | `roon_listen_later` | Your Listen Later list |
55
+ | `roon_versions` | Other versions of an album: remasters, hi-res, in your library and at Qobuz |
56
+ | `roon_similar` | More like this, for an album or an artist |
57
+ | `roon_signal_path` | Roon's signal path for what plays: is it bit-perfect, what happens on the way |
58
+ | `roon_dsp` | MUSE: the DSP set up for a zone |
59
+
60
+ **Playing** — only on your request:
61
+
62
+ | Tool | What it does |
63
+ |---|---|
64
+ | `roon_play` | An album on a zone: now, next or at the end of the queue, optionally shuffled |
65
+ | `roon_play_tracks` | Your own running order of tracks |
66
+ | `roon_control` | Pause, play, stop, next, previous |
67
+ | `roon_seek` | A position in the playing track |
68
+ | `roon_volume` | A zone's volume, mute |
69
+ | `roon_settings` | Shuffle, repeat, Roon Radio |
70
+ | `roon_queue_clear` | Clear what comes after the playing track (or everything) |
71
+ | `roon_transfer` | Move what plays, with its queue, to another zone |
72
+ | `roon_group`, `roon_ungroup` | Group zones, and undo it |
73
+ | `roon_sleep` | A sleep timer |
74
+ | `roon_standby` | Put a device in standby, or wake it |
75
+ | `roon_play_playlist` | A playlist on a zone, optionally shuffled |
76
+ | `roon_play_mix` | One of today's Daily Mixes |
77
+
78
+ **Changing your library or sound** — only on your request; each one reads the result back and says if Roon didn't follow:
79
+
80
+ | Tool | What it does |
81
+ |---|---|
82
+ | `roon_favorite` | A heart on an album or track, or off |
83
+ | `roon_listen_later_set` | On or off the Listen Later list |
84
+ | `roon_library_add` | A Qobuz album into your library |
85
+ | `roon_playlist_create` | A new playlist from tracks |
86
+ | `roon_dsp_set` | MUSE on or off, one part on or off, or a preset |
87
+
88
+ ## Install
89
+
90
+ Deep Roon MCP runs on a computer on the same network as your Roon Core (Mac, Windows or Linux), next to your MCP client.
91
+
92
+ ### Claude Desktop — one click
93
+
94
+ 1. Download **`deep-roon-mcp-<version>.mcpb`** from the [latest release](https://github.com/renebouwmeester/deep-roon-mcp/releases/latest).
95
+ 2. Open it (double-click, or drag it onto Claude Desktop's Settings › Extensions). Claude Desktop shows the tools and the
96
+ settings; click Install. It runs on Claude Desktop's own Node — nothing else to install.
97
+ 3. **In Roon:** Settings › Extensions › **Enable** next to "Deep Roon MCP". Once.
98
+ 4. Ask something: "What's new on Qobuz in jazz?", "Show me Roon's review of Kind of Blue", "Play Spirit of Eden in the
99
+ living room".
100
+
101
+ The settings (Claude Desktop › Settings › Extensions › Deep Roon MCP):
102
+
103
+ | Setting | What it does |
104
+ |---|---|
105
+ | Roon Core address | Empty: found on your network. Fill in the Core's address for another subnet or a private VPN (Tailscale) |
106
+ | Essentials only | Seventeen tools instead of fifty, for small models |
107
+ | Use Roon's internal protocol | Off: only the official API — zones, playback, volume, grouping; no search, reviews, Focus or history |
108
+
109
+ ### Other clients
110
+
111
+ Needs [Node.js](https://nodejs.org) 18 or newer. The package runs straight from npm with `npx`:
112
+
113
+ **Claude Code**
114
+
115
+ ```sh
116
+ claude mcp add deep-roon -- npx -y deep-roon-mcp
117
+ ```
118
+
119
+ **Cursor, VS Code, Windsurf, Cline, LM Studio, Claude Desktop by hand …** — in the client's MCP configuration:
120
+
121
+ ```json
122
+ {
123
+ "mcpServers": {
124
+ "deep-roon": {
125
+ "command": "npx",
126
+ "args": ["-y", "deep-roon-mcp"],
127
+ "env": { "ROON_HOST": "", "DEEP_ROON_TOOLS": "", "DEEP_ROON_INTERNAL": "" }
128
+ }
129
+ }
130
+ }
131
+ ```
132
+
133
+ The same three settings as environment variables: `ROON_HOST` (the Core's address, empty = find it), `DEEP_ROON_TOOLS=essentials`,
134
+ `DEEP_ROON_INTERNAL=off`. Leave out what you don't need. VS Code calls the block `"servers"` instead of `"mcpServers"`.
135
+
136
+ Then, once, in Roon: Settings › Extensions › **Enable** next to "Deep Roon MCP". Until then the tools say so.
137
+
138
+ ### From source
139
+
140
+ ```sh
141
+ git clone https://github.com/renebouwmeester/deep-roon-mcp
142
+ cd deep-roon-mcp && npm install && npm run build
143
+ # then use: node /path/to/deep-roon-mcp/dist/deep-roon-mcp.js
144
+ ```
145
+
146
+ ## When something's wrong
147
+
148
+ **"No Roon Core found" on a Mac:** macOS asks once whether the app may use the local network — for Claude Desktop that's
149
+ Claude and Claude Helper. Allow both (System Settings › Privacy & Security › Local Network), then try again.
150
+
151
+ Ask your client to run **`roon_status`**: the Core it found, whether it's enabled in Roon, whether the internal protocol
152
+ works, and a self-test of a few reads with the tools each stands for. After a Roon update a tool may break until Deep Roon
153
+ MCP is updated — the first answer says so when a newer version is out. Issues:
154
+ [github.com/renebouwmeester/deep-roon-mcp/issues](https://github.com/renebouwmeester/deep-roon-mcp/issues) (paste the
155
+ status; it holds no secrets).
156
+
157
+ ## How it behaves
158
+
159
+ - Short connections, as Roon Labs asked: opened for a question, closed after two minutes of quiet, one at a time, questions
160
+ one after another; a PING every 10 s while open, so the Core doesn't drop the session.
161
+ - Album, track and artist keys stay valid between calls.
162
+ - The log goes to stderr (your MCP client keeps it).
163
+ - At the start it asks GitHub once whether a newer release is out (`DEEP_ROON_NO_UPDATE_CHECK=1` turns that off). Nothing
164
+ else leaves your network except what your client sends to its model.
165
+ - The pairing with Roon is kept in your configuration folder (Mac `~/Library/Application Support/deep-roon-mcp`, Windows
166
+ `%APPDATA%\deep-roon-mcp`, Linux `~/.config/deep-roon-mcp`).
167
+
168
+ ## Credits
169
+
170
+ Arthur Soares for the protocol work (MIT, in `src/intern`). Roon Labs for allowing it.
171
+
172
+ ## License
173
+
174
+ Apache 2.0 — see `LICENSE` and `NOTICE`. Roon is a trademark of Roon Labs LLC; Qobuz of Xandrie SA.