kaleidoscope-mcp-server 1.0.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 +21 -0
- package/README.md +80 -0
- package/dist/index.js +1267 -0
- package/package.json +57 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Kaleidoscope contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# kaleidoscope-mcp-server
|
|
2
|
+
|
|
3
|
+
MCP server for [Kaleidoscope](https://github.com/Nathanael-R/kaleidoscope), a responsive preview and inspection tool for local web apps.
|
|
4
|
+
|
|
5
|
+
## What it can do
|
|
6
|
+
|
|
7
|
+
- start and stop Kaleidoscope services
|
|
8
|
+
- report service status
|
|
9
|
+
- prepare responsive preview sessions
|
|
10
|
+
- capture screenshots across multiple devices
|
|
11
|
+
- create authenticated proxy previews and inject mock data
|
|
12
|
+
- discover likely page elements from natural-language queries
|
|
13
|
+
- inspect a page element by CSS selector and return structured source metadata
|
|
14
|
+
|
|
15
|
+
## Install and run
|
|
16
|
+
|
|
17
|
+
Run it directly with `npx`:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx -y kaleidoscope-mcp-server
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The executable name is:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
kaleidoscope-mcp
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## MCP client config
|
|
30
|
+
|
|
31
|
+
Example stdio config:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"command": "npx",
|
|
36
|
+
"args": ["-y", "kaleidoscope-mcp-server"],
|
|
37
|
+
"env": {
|
|
38
|
+
"KALEIDOSCOPE_SERVER_URL": "http://localhost:5000"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Environment
|
|
44
|
+
|
|
45
|
+
- `KALEIDOSCOPE_SERVER_URL`
|
|
46
|
+
Defaults to `http://localhost:5000`.
|
|
47
|
+
- `KALEIDOSCOPE_CLIENT_PORT`
|
|
48
|
+
Optional preferred local client port for status and startup checks.
|
|
49
|
+
|
|
50
|
+
## Notes
|
|
51
|
+
|
|
52
|
+
- This package talks to the Kaleidoscope server API; it is not a standalone screenshot service by itself.
|
|
53
|
+
- Rich screenshot responses use MCP `structuredContent`, `resource_link`, and inline `image` blocks when the client supports them.
|
|
54
|
+
- Inspect remains selector-based and is limited to loopback/dev targets.
|
|
55
|
+
|
|
56
|
+
## Development
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npm install
|
|
60
|
+
npm run build
|
|
61
|
+
npm run check
|
|
62
|
+
npm test
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Publish to npm
|
|
66
|
+
|
|
67
|
+
Run this exact flow from `mcp-server/`:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npm adduser
|
|
71
|
+
npm run publish:check
|
|
72
|
+
npm run publish:public
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
`publish:check` runs the build, typecheck, tests, and an `npm publish --dry-run --access public` pass before the real publish.
|
|
76
|
+
|
|
77
|
+
More detailed usage and testing notes live in the main repository:
|
|
78
|
+
|
|
79
|
+
- [MCP testing guide](https://github.com/Nathanael-R/kaleidoscope/blob/master/Documentation/MCP-TESTING.md)
|
|
80
|
+
- [project README](https://github.com/Nathanael-R/kaleidoscope/blob/master/README.md)
|