@xtcel/reaui-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,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 The REA UI Authors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,118 @@
1
- # Temporary Holding Version
1
+ # @xtcel/reaui-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
+ **Give any AI agent the ability to produce editable design files.**
4
+
5
+ MCP server for [REA UI](https://github.com/xtcel/rea.ui). It wraps the `reaui` CLI so Claude Code, Cursor, Cline, or any MCP client can create, validate and pack `.reaui` design documents — React TSX + Tailwind that opens in the REA UI editor and exports as production code.
6
+
7
+ Agents are good at writing TSX and bad at guessing file layout. This server encodes the contract: one protocol resource, eight tools, and structured validation errors a model can act on without reading source.
8
+
9
+ ## Two transports, one package
10
+
11
+ | Transport | Use it for | Workspace |
12
+ |---|---|---|
13
+ | **stdio** (default) | Local work — your machine, your files | A real directory you choose with `--root` |
14
+ | **Streamable HTTP** | Self-hosted remote use, shared instances | One temporary directory per session, removed when the session ends |
15
+
16
+ ## Local (stdio)
17
+
18
+ ```bash
19
+ npx @xtcel/reaui-mcp # workspace = current directory
20
+ npx @xtcel/reaui-mcp --root /absolute/path/to/designs # explicit workspace
21
+ ```
22
+
23
+ Client configuration (Claude Desktop, Cursor, Cline):
24
+
25
+ ```json
26
+ {
27
+ "mcpServers": {
28
+ "reaui": {
29
+ "command": "npx",
30
+ "args": ["-y", "@xtcel/reaui-mcp", "--root", "/absolute/path/to/designs"]
31
+ }
32
+ }
33
+ }
34
+ ```
35
+
36
+ Claude Code:
37
+
38
+ ```bash
39
+ claude mcp add reaui -- npx -y @xtcel/reaui-mcp --root /absolute/path/to/designs
40
+ ```
41
+
42
+ You can also reach it through the CLI: `npx @xtcel/reaui-cli mcp`.
43
+
44
+ ## Remote (Streamable HTTP)
45
+
46
+ ```bash
47
+ npx @xtcel/reaui-mcp --http --port 8787 --token "$REAU_MASTER_TOKEN"
48
+ ```
49
+
50
+ | Flag | Default | Meaning |
51
+ |---|---|---|
52
+ | `--http` | off | Serve Streamable HTTP instead of stdio |
53
+ | `--port` | `8787` | Listen port |
54
+ | `--host` | `127.0.0.1` | Bind address. Set `0.0.0.0` only behind a proxy with auth |
55
+ | `--token` | none | Require `Authorization: Bearer <token>` on `/mcp` |
56
+ | `--ttl` | `60` | Minutes of inactivity before a session workspace is deleted |
57
+
58
+ Endpoints: `POST|GET|DELETE /mcp` (MCP), `GET /health` (liveness, unauthenticated).
59
+
60
+ Client configuration:
61
+
62
+ ```json
63
+ {
64
+ "mcpServers": {
65
+ "reaui-remote": {
66
+ "url": "https://your-host.example/mcp",
67
+ "headers": { "Authorization": "Bearer <your-token>" }
68
+ }
69
+ }
70
+ }
71
+ ```
72
+
73
+ Remote sessions are **not persisted**: the workspace is a temp directory created on `initialize` and deleted on `DELETE`, disconnect, or TTL expiry. If you need documents to survive a session, download them with `reaui_pack` and store them yourself.
74
+
75
+ ## Tools
76
+
77
+ | Tool | What it does |
78
+ |---|---|
79
+ | `reaui_create_design` | End-to-end: create document → write every page → validate → pack into `.reaui`. Returns validation errors without packing if anything is invalid |
80
+ | `reaui_write_page` | Write one page's TSX, add it to the manifest, validate immediately |
81
+ | `reaui_validate` | Validate a directory or `.reaui`; returns structured `code` / `path` / `message` / `hint` |
82
+ | `reaui_init` | Create a minimal valid document |
83
+ | `reaui_pack` | Pack a validated document into a single `.reaui` |
84
+ | `reaui_unpack` | Unpack `.reaui` into a directory for page-by-page edits |
85
+ | `reaui_preview` | Render a self-contained `preview.html` |
86
+ | `reaui_diff` | Compare two design sources and report what changed |
87
+
88
+ All paths are relative to the workspace root; absolute paths and `..` escapes are rejected.
89
+
90
+ ## Resource
91
+
92
+ `reaui://protocol` returns the full agent design protocol as Markdown: allowed primitives, static-only prop rules, Tailwind conventions, hard limits, and every validation error code. Clients that support resources should read it once at the start of a session.
93
+
94
+ ## Typical flow
95
+
96
+ ```text
97
+ reaui_init → demo/
98
+ reaui_write_page → demo/pages/main.page.tsx (validates, returns errors)
99
+ reaui_write_page → demo/pages/settings.page.tsx
100
+ reaui_pack → demo.reaui
101
+ reaui_preview → preview.html
102
+ ```
103
+
104
+ Or a single `reaui_create_design` call when the whole design is ready at once.
105
+
106
+ ## How it works
107
+
108
+ The server runs the published `@xtcel/reaui-cli` in a subprocess and parses its `--json` output. Validation is therefore identical to the editor — a document that passes here opens in REA UI. Page code is never executed; it is parsed as a static AST subset.
109
+
110
+ In stdio mode the server's own stdout carries JSON-RPC only; every log goes to stderr.
111
+
112
+ ## Requirements
113
+
114
+ Node.js **22.18+**. macOS, Linux, Windows. No Rust toolchain.
115
+
116
+ ## License
117
+
118
+ [Apache-2.0](https://github.com/xtcel/rea.ui/blob/main/LICENSE)
@@ -0,0 +1,80 @@
1
+ #!/usr/bin/env node
2
+ import { existsSync } from 'node:fs';
3
+ import path from 'node:path';
4
+ import { fileURLToPath, pathToFileURL } from 'node:url';
5
+
6
+ const here = path.dirname(fileURLToPath(import.meta.url));
7
+ const dist = path.join(here, '..', 'dist', 'reaui-mcp.mjs');
8
+
9
+ const argv = process.argv.slice(2);
10
+
11
+ function flag(name) {
12
+ const index = argv.findIndex(arg => arg === `--${name}` || arg.startsWith(`--${name}=`));
13
+ if (index < 0) return undefined;
14
+ const arg = argv[index];
15
+ if (arg.includes('=')) return arg.slice(arg.indexOf('=') + 1);
16
+ const next = argv[index + 1];
17
+ return next && !next.startsWith('--') ? next : true;
18
+ }
19
+
20
+ if (flag('help') || argv.includes('-h')) {
21
+ console.log(`reaui-mcp - MCP server for REA UI
22
+
23
+ Usage:
24
+ reaui-mcp stdio transport, workspace defaults to the current directory
25
+ reaui-mcp --root <dir> stdio transport with an explicit workspace root
26
+ reaui-mcp --http Streamable HTTP transport on 127.0.0.1:8787
27
+ reaui-mcp --http --port 8080 choose the port
28
+ reaui-mcp --http --host 0.0.0.0 --token <secret> expose publicly with bearer auth
29
+
30
+ Options:
31
+ --root <dir> workspace directory (stdio mode), defaults to cwd
32
+ --http serve over Streamable HTTP instead of stdio
33
+ --port <n> HTTP port, default 8787
34
+ --host <addr> HTTP bind address, default 127.0.0.1
35
+ --token <secret> require Authorization: Bearer <secret> (HTTP mode)
36
+ --ttl <minutes> idle session lifetime in minutes, default 60
37
+ --version print the version
38
+ --help print this help
39
+ `);
40
+ process.exit(0);
41
+ }
42
+
43
+ if (!existsSync(dist)) {
44
+ console.error('缺少构建产物,请先运行:pnpm --filter @xtcel/reaui-mcp build');
45
+ process.exit(2);
46
+ }
47
+
48
+ const module = await import(pathToFileURL(dist).href);
49
+
50
+ if (flag('version')) {
51
+ console.log(module.VERSION);
52
+ process.exit(0);
53
+ }
54
+
55
+ const http = Boolean(flag('http'));
56
+
57
+ try {
58
+ if (http) {
59
+ const port = Number(flag('port') ?? 8787);
60
+ const host = typeof flag('host') === 'string' ? flag('host') : '127.0.0.1';
61
+ const token = typeof flag('token') === 'string' ? flag('token') : undefined;
62
+ const ttlMinutes = Number(flag('ttl') ?? 60);
63
+ const server = await module.startHttp({ port, host, token, ttlMs: ttlMinutes * 60_000 });
64
+ console.error(`[reaui-mcp] listening on ${server.url}${token ? ' (bearer auth)' : ''}`);
65
+ const shutdown = async () => {
66
+ await server.close();
67
+ process.exit(0);
68
+ };
69
+ process.on('SIGINT', () => void shutdown());
70
+ process.on('SIGTERM', () => void shutdown());
71
+ } else {
72
+ const root = path.resolve(process.cwd(), typeof flag('root') === 'string' ? flag('root') : '.');
73
+ const server = module.createReauiServer({ root });
74
+ await module.startStdio(server);
75
+ console.error(`[reaui-mcp] workspace ${root}`);
76
+ }
77
+ } catch (error) {
78
+ console.error(`[reaui-mcp] ${error instanceof Error ? error.message : String(error)}`);
79
+ process.exit(2);
80
+ }