text-to-design-mcp 0.1.1 → 0.3.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/README.md +89 -49
- package/dist/index.js +1532 -293
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -1,10 +1,38 @@
|
|
|
1
|
-
# text-to-design
|
|
1
|
+
# text-to-design 后台服务
|
|
2
2
|
|
|
3
|
-
让 AI 助手直接帮你操作即时设计(jsDesign)
|
|
3
|
+
让 AI 助手直接帮你操作即时设计(jsDesign)画布:读取选中内容、按描述画图、改样式、导出图片。装好后不用手动启动任何东西,打开 AI 工具就能用。
|
|
4
|
+
|
|
5
|
+
这里说的「后台服务」,就是负责在 AI 和设计软件插件之间传话的那个小帮手。
|
|
6
|
+
|
|
7
|
+
## 能做什么
|
|
8
|
+
|
|
9
|
+
- 读取画布当前选中的内容
|
|
10
|
+
- 按你的描述画图:卡片、按钮、文字、形状等
|
|
11
|
+
- 修改已有内容:改位置、颜色、文字、圆角
|
|
12
|
+
- 把多个元素合成一个图形、给图形加轮廓
|
|
13
|
+
- 把图形变成可反复复用的组件
|
|
14
|
+
- 导出图片(PNG / JPG / SVG / PDF)
|
|
15
|
+
- 用本地图片填充图形
|
|
4
16
|
|
|
5
17
|
## 安装(三步)
|
|
6
18
|
|
|
7
|
-
|
|
19
|
+
**第一步:告诉 AI 工具**
|
|
20
|
+
|
|
21
|
+
后台服务不用手动安装,AI 工具需时会通过 `npx` 自动拉取运行。在项目根目录的 `opencode.json`(没有就新建)里加:
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"mcp": {
|
|
26
|
+
"text-to-design": {
|
|
27
|
+
"type": "local",
|
|
28
|
+
"command": ["npx", "-y", "text-to-design-mcp@latest"],
|
|
29
|
+
"enabled": true
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
如果想全局安装(装一次、不依赖联网拉取),也可以用任意包管理器:
|
|
8
36
|
|
|
9
37
|
| 管理器 | 命令 |
|
|
10
38
|
| --- | --- |
|
|
@@ -12,9 +40,11 @@
|
|
|
12
40
|
| pnpm | `pnpm add -g text-to-design-mcp` |
|
|
13
41
|
| yarn | `yarn global add text-to-design-mcp` |
|
|
14
42
|
|
|
15
|
-
|
|
43
|
+
全局安装后,上面的 `command` 可简化成 `["text-to-design-mcp"]`。
|
|
16
44
|
|
|
17
|
-
|
|
45
|
+
**第二步:安装设计软件插件**
|
|
46
|
+
|
|
47
|
+
先拿到插件包(任选):
|
|
18
48
|
|
|
19
49
|
| 管理器 | 命令 |
|
|
20
50
|
| --- | --- |
|
|
@@ -22,27 +52,11 @@
|
|
|
22
52
|
| pnpm | `pnpm pack text-to-design-ui` |
|
|
23
53
|
| yarn | `yarn dlx npm pack text-to-design-ui` |
|
|
24
54
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
**第三步:告诉 AI 工具**
|
|
28
|
-
|
|
29
|
-
在项目根目录的 `opencode.json`(没有就新建)里加:
|
|
30
|
-
|
|
31
|
-
```json
|
|
32
|
-
{
|
|
33
|
-
"mcp": {
|
|
34
|
-
"text-to-design": {
|
|
35
|
-
"type": "local",
|
|
36
|
-
"command": ["text-to-design-mcp"],
|
|
37
|
-
"enabled": true
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
```
|
|
55
|
+
解压得到的安装包里有个 `dist` 文件夹。在即时设计里点「插件 → 导入」,选择里面的 `manifest.json`,然后回到画布运行插件。面板显示「已连接」就是准备好了。
|
|
42
56
|
|
|
43
|
-
|
|
57
|
+
**第三步:重启 AI 工具**
|
|
44
58
|
|
|
45
|
-
改完重启
|
|
59
|
+
改完重启 AI 工具会话(首次使用会自动拉取后台服务并常驻运行)。
|
|
46
60
|
|
|
47
61
|
## 怎么用
|
|
48
62
|
|
|
@@ -52,50 +66,76 @@
|
|
|
52
66
|
- 「在画布中心画一个 300x200 的卡片,标题叫发布页,背景浅灰」
|
|
53
67
|
- 「把选中的按钮导出成 PNG 存到 /tmp/btn.png」
|
|
54
68
|
|
|
55
|
-
想确认插件通不通,先让它调 `
|
|
69
|
+
想确认插件通不通,先让它调 `jsd_ping`。
|
|
70
|
+
|
|
71
|
+
## 常见问题
|
|
72
|
+
|
|
73
|
+
- **AI 说连不上插件**:看即时设计里的插件面板是不是「已连接」,没有就重新运行插件,再重启 AI 会话
|
|
74
|
+
- **改了配置没反应**:重启 AI 工具会话
|
|
75
|
+
- **想深入排查**:看文末「给开发者看」的日志部分
|
|
76
|
+
- **旧版升级见下方「升级」**
|
|
77
|
+
|
|
78
|
+
## 升级
|
|
79
|
+
|
|
80
|
+
新版起会自动替换:启动时若检测到旧版常驻服务,会自动关停并拉起新版,无需手动操作。
|
|
81
|
+
|
|
82
|
+
仅从旧版(没有自动替换能力)升级时,首次需手动清理一次残留的常驻服务:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
pkill -f text-to-design-mcp
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
之后任意一次 AI 调用会自动拉起新版服务。
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## 给开发者看
|
|
93
|
+
|
|
94
|
+
以下内容供开发、排查问题的人参考。
|
|
56
95
|
|
|
57
|
-
|
|
96
|
+
### 完整工具清单
|
|
58
97
|
|
|
59
98
|
| 工具 | 用途 |
|
|
60
99
|
| --- | --- |
|
|
61
|
-
| `
|
|
62
|
-
| `
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
69
|
-
| `
|
|
70
|
-
| `
|
|
71
|
-
| `
|
|
72
|
-
| `
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
- 一个常驻的轻量服务负责和插件通信,连接 jsDesign 里的插件
|
|
100
|
+
| `jsd_ping` | 检查插件是否在线 |
|
|
101
|
+
| `jsd_get_selection` | 读取画布当前选中的节点 |
|
|
102
|
+
| `jsd_execute` | 按描述创建节点(frame/rect/text 等,支持阴影/描边/渐变/文本样式) |
|
|
103
|
+
| `jsd_create_svg` | 直接导入 SVG 字符串(保留 path/矢量数据,不经降级) |
|
|
104
|
+
| `jsd_html_to_design` | 把 HTML 转成设计节点 |
|
|
105
|
+
| `jsd_update_selection` | 修改选中节点的属性(位置/颜色/文字/圆角等) |
|
|
106
|
+
| `jsd_find` | 按名称/类型查找节点 |
|
|
107
|
+
| `jsd_manage_nodes` | 节点结构操作,op 含 select/remove/clone/group/ungroup/flatten/outline_stroke/reparent/repair(清理引擎残留失效节点) |
|
|
108
|
+
| `jsd_manage_components` | 组件/实例操作,op 含 create_component(建空壳,子节点用 reparent 归入)/create_instance/detach_instance/import_component/swap_component/set_instance_properties/combine_as_variants |
|
|
109
|
+
| `jsd_export` | 导出节点为 PNG/JPG/SVG/PDF |
|
|
110
|
+
| `jsd_list_fonts` | 列出可用字体 |
|
|
111
|
+
| `jsd_fill_image` | 用本地图片填充节点 |
|
|
112
|
+
|
|
113
|
+
### 工作原理(简版)
|
|
114
|
+
|
|
115
|
+
- 一个常驻的轻量服务负责和插件通信,连接即时设计里的插件
|
|
78
116
|
- 每个 AI 会话会自动连上这个服务;会话关掉不影响插件
|
|
79
|
-
-
|
|
117
|
+
- 服务常驻;更新版本时自动替换,无需手动清理(旧版首次升级除外,见「升级」)
|
|
80
118
|
- 多个会话可以同时用,共享同一个插件连接
|
|
81
119
|
|
|
82
|
-
|
|
120
|
+
### 环境变量
|
|
83
121
|
|
|
84
122
|
| 变量 | 默认 | 说明 |
|
|
85
123
|
| --- | --- | --- |
|
|
86
124
|
| `TEXT_TO_DESIGN_MCP_PORT` | `47812` | 与插件通信的端口(被占用会启动失败) |
|
|
87
125
|
| `TEXT_TO_DESIGN_MCP_HTTP_PORT` | `47820` | 内部服务端口(一般不用动) |
|
|
88
126
|
| `TEXT_TO_DESIGN_MCP_LOG` | `/tmp/text-to-design-mcp.log` | 日志文件路径 |
|
|
127
|
+
| `TEXT_TO_DESIGN_MCP_LOG_LEVEL` | `info` | 日志级别:`debug`/`info`/`warn`/`error` |
|
|
89
128
|
|
|
90
|
-
|
|
129
|
+
### 日志排查
|
|
91
130
|
|
|
92
|
-
- 看日志:`tail -f /tmp/text-to-design-mcp.log`(
|
|
131
|
+
- 看日志:`tail -f /tmp/text-to-design-mcp.log`(请求/响应耗时、HTTP 状态码、插件连接、二进制组装都会记)
|
|
132
|
+
- 要更细的连接日志,启动时设 `TEXT_TO_DESIGN_MCP_LOG_LEVEL=debug`(默认 info)
|
|
93
133
|
- 插件面板自带连接状态和日志,也能帮定位
|
|
94
134
|
|
|
95
|
-
|
|
135
|
+
### 构建与开发
|
|
96
136
|
|
|
97
137
|
```bash
|
|
98
138
|
pnpm install
|
|
99
139
|
pnpm dev # watch 构建 ui/code
|
|
100
|
-
pnpm mcp #
|
|
140
|
+
pnpm mcp # 开发态启动后台服务(tsx 直跑)
|
|
101
141
|
```
|