text-to-design-mcp 0.1.0 → 0.1.1
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 +64 -51
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -1,88 +1,101 @@
|
|
|
1
1
|
# text-to-design-mcp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
让 AI 助手直接帮你操作即时设计(jsDesign)画布:读取选中内容、按描述画图、改样式、导出图片。装好后不用手动启动任何服务,打开 AI 工具就能用。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## 安装(三步)
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
jsDesign 插件 ──WS 47812──▶ daemon(独立常驻:WS server + MCP HTTP 47820)
|
|
9
|
-
▲ ▲
|
|
10
|
-
opencode 会话A ──stdio──▶ shim A ──┘ HTTP ───────┤
|
|
11
|
-
opencode 会话B ──stdio──▶ shim B ──┘ HTTP ───────┘
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
- **daemon**:插件 WS(47812)+ MCP streamable HTTP(47820),无 stdio。独立于任何会话进程,**会话关闭不影响插件连接**;空闲 5 分钟无请求自动退出
|
|
15
|
-
- **shim**:每个 opencode 会话由 `type: local` spawn 一个,探测 47820:
|
|
16
|
-
- 已有 daemon → 直接代理(自家 stdio 透传到 daemon HTTP 端点,不启 WS)
|
|
17
|
-
- 无 daemon → detached 自动拉起 daemon,等待就绪后代理
|
|
18
|
-
- 端口被外来服务占用 → fail-fast 明确报错
|
|
19
|
-
- 多个 opencode 会话**同时可用**,全部经各自 shim 共享同一 daemon、同一插件连接
|
|
7
|
+
**第一步:安装 MCP server**(任选一种包管理器)
|
|
20
8
|
|
|
21
|
-
|
|
9
|
+
| 管理器 | 命令 |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| npm | `npm i -g text-to-design-mcp` |
|
|
12
|
+
| pnpm | `pnpm add -g text-to-design-mcp` |
|
|
13
|
+
| yarn | `yarn global add text-to-design-mcp` |
|
|
22
14
|
|
|
23
|
-
|
|
15
|
+
**第二步:安装 jsDesign 插件**
|
|
24
16
|
|
|
25
|
-
|
|
17
|
+
下载插件包(任选):
|
|
26
18
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
19
|
+
| 管理器 | 命令 |
|
|
20
|
+
| --- | --- |
|
|
21
|
+
| npm | `npm pack text-to-design-ui` |
|
|
22
|
+
| pnpm | `pnpm pack text-to-design-ui` |
|
|
23
|
+
| yarn | `yarn dlx npm pack text-to-design-ui` |
|
|
30
24
|
|
|
31
|
-
|
|
25
|
+
解压得到的 tgz 里有个 `dist/manifest.json`,在 jsDesign 里「插件 → 导入」选择它,然后在画布运行插件,面板显示「已连接」就绪了。
|
|
32
26
|
|
|
33
|
-
|
|
27
|
+
**第三步:告诉 AI 工具**
|
|
34
28
|
|
|
35
|
-
|
|
29
|
+
在项目根目录的 `opencode.json`(没有就新建)里加:
|
|
36
30
|
|
|
37
31
|
```json
|
|
38
32
|
{
|
|
39
33
|
"mcp": {
|
|
40
34
|
"text-to-design": {
|
|
41
35
|
"type": "local",
|
|
42
|
-
"command": ["
|
|
36
|
+
"command": ["text-to-design-mcp"],
|
|
43
37
|
"enabled": true
|
|
44
38
|
}
|
|
45
39
|
}
|
|
46
40
|
}
|
|
47
41
|
```
|
|
48
42
|
|
|
49
|
-
|
|
43
|
+
(没做全局安装的话,把 command 换成 `["npx", "text-to-design-mcp"]` 也可以)
|
|
50
44
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
45
|
+
改完重启 opencode 会话。
|
|
46
|
+
|
|
47
|
+
## 怎么用
|
|
48
|
+
|
|
49
|
+
打开会话后直接说人话,比如:
|
|
56
50
|
|
|
57
|
-
|
|
51
|
+
- 「读取当前画布选中的内容」
|
|
52
|
+
- 「在画布中心画一个 300x200 的卡片,标题叫发布页,背景浅灰」
|
|
53
|
+
- 「把选中的按钮导出成 PNG 存到 /tmp/btn.png」
|
|
58
54
|
|
|
59
|
-
|
|
60
|
-
- 空闲 5 分钟无 HTTP 请求自动退出;插件连接不影响该计时(插件会自动重连)
|
|
61
|
-
- 手动清理:`pkill -f "index.ts daemon"`
|
|
55
|
+
想确认插件通不通,先让它调 `text_to_design_ping`。
|
|
62
56
|
|
|
63
|
-
##
|
|
57
|
+
## 它能做什么(工具一览)
|
|
64
58
|
|
|
65
|
-
| 工具 |
|
|
59
|
+
| 工具 | 用途 |
|
|
66
60
|
| --- | --- |
|
|
67
|
-
| `text_to_design_ping` |
|
|
68
|
-
| `text_to_design_get_selection` |
|
|
69
|
-
| `text_to_design_execute` |
|
|
70
|
-
| `text_to_design_html_to_design` |
|
|
71
|
-
| `text_to_design_update_selection` |
|
|
61
|
+
| `text_to_design_ping` | 检查插件是否在线 |
|
|
62
|
+
| `text_to_design_get_selection` | 读取画布当前选中的节点 |
|
|
63
|
+
| `text_to_design_execute` | 按描述创建节点(frame/rect/text 等,支持阴影/描边/渐变/文本样式) |
|
|
64
|
+
| `text_to_design_html_to_design` | 把 HTML 转成设计节点 |
|
|
65
|
+
| `text_to_design_update_selection` | 修改选中节点的属性(位置/颜色/文字/圆角等) |
|
|
72
66
|
| `text_to_design_find` | 按名称/类型查找节点 |
|
|
73
67
|
| `text_to_design_set_selection` | 设置画布选中节点 |
|
|
74
|
-
| `text_to_design_remove` | 删除节点
|
|
68
|
+
| `text_to_design_remove` | 删除节点 |
|
|
75
69
|
| `text_to_design_clone` | 复制节点 |
|
|
76
|
-
| `text_to_design_group` |
|
|
77
|
-
| `text_to_design_export` | 导出节点为 PNG/JPG/SVG/PDF
|
|
78
|
-
| `text_to_design_list_fonts` |
|
|
79
|
-
| `text_to_design_fill_image` |
|
|
70
|
+
| `text_to_design_group` | 编组 / 取消编组 |
|
|
71
|
+
| `text_to_design_export` | 导出节点为 PNG/JPG/SVG/PDF |
|
|
72
|
+
| `text_to_design_list_fonts` | 列出可用字体 |
|
|
73
|
+
| `text_to_design_fill_image` | 用本地图片填充节点 |
|
|
74
|
+
|
|
75
|
+
## 工作原理(简单版)
|
|
76
|
+
|
|
77
|
+
- 一个常驻的轻量服务负责和插件通信,连接 jsDesign 里的插件
|
|
78
|
+
- 每个 AI 会话会自动连上这个服务;会话关掉不影响插件
|
|
79
|
+
- 一段时间没人用,服务自动退出;下次会话会自动把它再拉起来
|
|
80
|
+
- 多个会话可以同时用,共享同一个插件连接
|
|
81
|
+
|
|
82
|
+
## 环境变量
|
|
83
|
+
|
|
84
|
+
| 变量 | 默认 | 说明 |
|
|
85
|
+
| --- | --- | --- |
|
|
86
|
+
| `TEXT_TO_DESIGN_MCP_PORT` | `47812` | 与插件通信的端口(被占用会启动失败) |
|
|
87
|
+
| `TEXT_TO_DESIGN_MCP_HTTP_PORT` | `47820` | 内部服务端口(一般不用动) |
|
|
88
|
+
| `TEXT_TO_DESIGN_MCP_LOG` | `/tmp/text-to-design-mcp.log` | 日志文件路径 |
|
|
89
|
+
|
|
90
|
+
## 出问题了
|
|
91
|
+
|
|
92
|
+
- 看日志:`tail -f /tmp/text-to-design-mcp.log`(请求发出、收到回复、超时都会记)
|
|
93
|
+
- 插件面板自带连接状态和日志,也能帮定位
|
|
80
94
|
|
|
81
|
-
##
|
|
95
|
+
## 开发者(仓库内)
|
|
82
96
|
|
|
83
97
|
```bash
|
|
84
98
|
pnpm install
|
|
85
|
-
pnpm dev
|
|
86
|
-
pnpm mcp
|
|
87
|
-
pnpm --filter text-to-design-mcp start # 或直接进 packages/mcp-server 跑 start
|
|
99
|
+
pnpm dev # watch 构建 ui/code
|
|
100
|
+
pnpm mcp # 开发态启动 MCP server(tsx 直跑)
|
|
88
101
|
```
|
package/package.json
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "text-to-design-mcp",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "MCP server bridging AI clients to the jsDesign (即时设计) desktop plugin via a local WebSocket",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/wzrove/text-to-design"
|
|
8
|
+
},
|
|
5
9
|
"type": "module",
|
|
6
10
|
"bin": {
|
|
7
11
|
"text-to-design-mcp": "dist/index.js"
|