@olonjs/mcp 1.0.156 → 1.0.157
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/README.md +57 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# @olonjs/mcp
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<strong>Local MCP server bridge for OlonJS.</strong><br />
|
|
5
|
+
Zero-UI tenant automation: drive the Studio route's WebMCP surface through Playwright, exposed as MCP tools.
|
|
6
|
+
</p>
|
|
7
|
+
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://www.npmjs.com/package/@olonjs/mcp"><img src="https://img.shields.io/npm/v/@olonjs/mcp?color=blue&style=flat-square" alt="npm version"></a>
|
|
10
|
+
<a href="https://github.com/olonjs/npm-jpcore/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green?style=flat-square" alt="license"></a>
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
**@olonjs/mcp** exposes a local **stdio MCP server** (`olonjs-mcp`) that drives a running OlonJS tenant in a headless browser via Playwright. Whatever the tenant's Studio route registers on `document.modelContextProtocol` becomes callable MCP tools — plus the extra `navigate-to-page` helper. Ideal for Cursor/Cline/Claude-style agent clients that need Zero-UI mutations.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install -g @olonjs/mcp
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Start the MCP server (stdio)
|
|
25
|
+
olonjs-mcp
|
|
26
|
+
|
|
27
|
+
# Write the MCP client config for Cursor / Cline
|
|
28
|
+
olonjs-mcp init
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`init` writes the client configuration natively for Windows and macOS; under WSL it wires the Windows side via `wsl -d <distro> bash -ilc`.
|
|
32
|
+
|
|
33
|
+
## How It Works
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
MCP client (Cursor/Cline) ──stdio──► olonjs-mcp ──Playwright──► tenant Studio route
|
|
37
|
+
│ │
|
|
38
|
+
└── tools = runtime WebMCP └── document.modelContextProtocol
|
|
39
|
+
registry (+ navigate-to-page)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
The bridge is **dynamic**: it lists whatever tools the tenant registers at runtime — built-in Studio tools (`update-section`, `save`) and declared admin tools (WTP) included. No per-tool bridge code.
|
|
43
|
+
|
|
44
|
+
## Requirements
|
|
45
|
+
|
|
46
|
+
- Node 18+ and a Playwright-capable browser (installed on demand)
|
|
47
|
+
- A running tenant with WebMCP enabled on the Studio route
|
|
48
|
+
|
|
49
|
+
> **Note:** this bridge targets the Studio (admin) route. Visitor-page (public surface) verification is done directly in-browser via `document.modelContextProtocol` — see [`docs/webmcp.md`](../../docs/webmcp.md) and the WTP spec in [`specs/2.0/INDEX.md`](../../specs/2.0/INDEX.md).
|
|
50
|
+
|
|
51
|
+
## Versioning
|
|
52
|
+
|
|
53
|
+
Patch-only auto-numbering (`1.0.XXX`) by the gated `release:enterprise` pipeline.
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT — see [LICENSE](../../LICENSE).
|