ply-ui-mcp 0.1.21 → 0.1.22

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.
Files changed (2) hide show
  1. package/README.md +27 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -12,7 +12,7 @@ Docs: [Getting started — AI agents](https://ply-ui.com/getting-started/#ai-age
12
12
 
13
13
  ## Setup (stdio)
14
14
 
15
- Use this in Cursor, Claude Code / Desktop, Kimi, VS Code, Windsurf, and other local MCP hosts:
15
+ Cursor, Windsurf, Claude Desktop, Antigravity, and most other local hosts read this `mcpServers` block:
16
16
 
17
17
  ```json
18
18
  {
@@ -28,16 +28,34 @@ Use this in Cursor, Claude Code / Desktop, Kimi, VS Code, Windsurf, and other lo
28
28
  }
29
29
  ```
30
30
 
31
- | Client | Where to put it |
32
- |--------|-----------------|
31
+ VS Code uses `servers` instead of `mcpServers` and needs a `type`. It starts the server in the workspace folder, so `PLY_CWD` is optional:
32
+
33
+ ```json
34
+ {
35
+ "servers": {
36
+ "ply": {
37
+ "type": "stdio",
38
+ "command": "npx",
39
+ "args": ["-y", "ply-ui-mcp"]
40
+ }
41
+ }
42
+ }
43
+ ```
44
+
45
+ | Client | Setup |
46
+ |--------|-------|
33
47
  | **Cursor** | `.cursor/mcp.json` or `~/.cursor/mcp.json` |
34
- | **VS Code / Copilot** | `.vscode/mcp.json` or MCP settings |
35
- | **Windsurf** | MCP / Cascade settings |
36
- | **Claude Desktop** | Claude Desktop MCP config |
48
+ | **VS Code / Copilot** | `.vscode/mcp.json` (the `servers` block above) |
37
49
  | **Claude Code** | `claude mcp add --transport stdio ply -- npx -y ply-ui-mcp` |
50
+ | **Codex** | `codex mcp add ply -- npx -y ply-ui-mcp` |
51
+ | **Antigravity** (replaces Gemini CLI) | `.agents/mcp_config.json` in the app, or `~/.gemini/config/mcp_config.json` |
52
+ | **Grok Build** | `grok mcp add ply -- npx -y ply-ui-mcp` (also reads `.cursor/mcp.json` and `.mcp.json`) |
38
53
  | **Kimi Code CLI** | `kimi mcp add --transport stdio ply -- npx -y ply-ui-mcp` |
54
+ | **Qwen Code** | `qwen mcp add ply npx -y ply-ui-mcp` |
55
+ | **Windsurf** | `~/.codeium/windsurf/mcp_config.json` |
56
+ | **Claude Desktop** | `claude_desktop_config.json` |
39
57
 
40
- Set `PLY_CWD` to the **app root** (the folder with `ply-ui.json`), not this library’s repo. For `add` / `init` / `update` / `doctor` / `diff`, run `npx ply-ui-cli init --yes` in that app first.
58
+ Set `PLY_CWD` to the **app root** (the folder with `ply-ui.json`), not this library’s repo. `${workspaceFolder}` works in Cursor and VS Code; Windsurf and Claude Desktop need an absolute path. Terminal agents (Claude Code, Codex, Grok Build, Kimi, Qwen) start the server in the folder you run them in, so run them from the app root. For `add` / `init` / `update` / `doctor` / `diff`, run `npx ply-ui-cli init --yes` in that app first.
41
59
 
42
60
  ## Streamable HTTP
43
61
 
@@ -45,7 +63,7 @@ ChatGPT and Gemini chat apps need a URL, not stdio. The hosted catalog is:
45
63
 
46
64
  **`https://mcp.ply-ui.com/mcp`**
47
65
 
48
- Health is `GET https://mcp.ply-ui.com/`. Catalog tools only (`list` / `search` / `get`). This host cannot install into a repo — it returns `installCommand` (`npx ply-ui-cli add <name>`). Attach the connector in **each new ChatGPT chat** (`+` → More → Developer mode → Ply).
66
+ Health is `GET https://mcp.ply-ui.com/`. Catalog tools only (`list` / `search` / `get`). This host cannot install into a repo — it returns `installCommand` (`npx ply-ui-cli add <name>`). Set it up with [ChatGPT developer mode](https://developers.openai.com/api/docs/guides/developer-mode) or as a [Gemini custom app](https://support.google.com/gemini/answer/17209137).
49
67
 
50
68
  Self-host the same process:
51
69
 
@@ -179,7 +197,7 @@ Run npx ply-ui-cli doctor. It checks ply-ui.json, the Angular workspace, @angula
179
197
  Open Theme Studio at https://ply-ui.com/theme/ or the docs customizer, pick a preset or hue, then copy the Tailwind v4 @theme block into src/tailwind.css. ply-ui.css points --ply-primary and Tailwind blue-* utilities at that palette (--ply-brand and --ply-scale-*). The live preview shows buttons, tabs, forms, and overlays together.
180
198
 
181
199
  **Can AI agents install Ply?**
182
- Yes. npx -y ply-ui-mcp is stdio for Cursor, Claude (Code/Desktop), Kimi, VS Code, Windsurf, and other local hosts. ChatGPT and Gemini chat apps use the Streamable HTTP connector at https://mcp.ply-ui.com/mcp (catalog tools) or a local npx -y ply-ui-mcp --http without --read-only so add/init/update can see the project. Pro add uses PLY_LICENSE_KEY on the MCP process. Editors that skip MCP can copy the Cursor rule and snippet pack from https://ply-ui.com/getting-started/#editor-rules.
200
+ Yes. npx -y ply-ui-mcp runs over stdio in Cursor, VS Code, Claude Code, Claude Desktop, Codex, Antigravity, Grok Build, Kimi Code, Qwen Code, Windsurf, and other local hosts. ChatGPT and Gemini chat apps use the Streamable HTTP connector at https://mcp.ply-ui.com/mcp (catalog tools) or a local npx -y ply-ui-mcp --http without --read-only so add/init/update can see the project. Pro add uses PLY_LICENSE_KEY on the MCP process. Setup for each host: https://ply-ui.com/getting-started/#ai-agents-mcp. Editors that skip MCP can copy the Cursor rule and snippet pack from https://ply-ui.com/getting-started/#editor-rules.
183
201
 
184
202
  **Do AI agents use fewer tokens with Ply?**
185
203
  Usually, yes. With Ply the agent copies a finished component (CLI or MCP) and wires it, instead of generating a toolbar, selection model, sanitizer, and SSR guards from a blank file. Token use still depends on the prompt and the model. A reconstructed Claude/Grok session for the rich text editor is at https://ply-ui.com/learn/ai-agent-tokens-rich-text-editor/ — that is a teaching simulation, not a lab benchmark.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ply-ui-mcp",
3
- "version": "0.1.21",
3
+ "version": "0.1.22",
4
4
  "description": "Ply MCP server — stdio or Streamable HTTP (--http). List, search, init, doctor, diff, update, and add Angular + Tailwind components (Pro with PLY_LICENSE_KEY). Not MUI Base UI.",
5
5
  "type": "commonjs",
6
6
  "main": "dist/index.js",