tmui-cli 2.0.0 → 2.0.1

package/README.md

@@ -1,6 +1,6 @@
 # tmui-cli
 
-TMUI DESIGN 终端工具：在命令行里创建或升级 uniapp CLI / HBX 项目，不再打开浏览器。
+TMUI DESIGN 终端工具：在命令行里创建或升级 uniapp CLI / HBX 项目，也可作为 IDE 的 MCP 服务。
 
 ## 环境
 
@@ -15,13 +15,7 @@ tmui
 
 ## 使用
 
-在任意目录执行 `tmui`：
-
-1. 打印 TMUI DESIGN logo
-2. 检测当前目录是否已是 uniapp 项目
-3. 菜单选择 **创建项目** 或 **升级项目**
-
-创建 CLI 项目时会依次选择：项目类型（CLI / HBX）→ 目录 → 名称 → TMUI 版本 → UniSdk 通道与版本 → **npm 或 pnpm**。依赖安装固定使用阿里云源 `https://registry.npmmirror.com`。
+在任意目录执行 `tmui`
 
 升级：
 
@@ -29,3 +23,57 @@ tmui
 - UniSdk：仅 CLI，改 `package.json` 后用所选 npm/pnpm 安装
 
 按键：`↑/↓` 选择，`Enter` 确认，`Esc` 返回，`Ctrl+C` 退出。
+
+## MCP（给 Cursor / VS Code 等 IDE 用）
+
+`tmui mcp` 启动 MCP stdio 服务，**不会**打开交互界面。stdout 只走协议。
+
+全局安装后，在 IDE 的 MCP 配置里写：
+
+```json
+{
+  "mcpServers": {
+    "tmui": {
+      "command": "tmui",
+      "args": ["mcp"]
+    }
+  }
+}
+```
+
+或用 npx（无需全局安装）：
+
+```json
+{
+  "mcpServers": {
+    "tmui": {
+      "command": "npx",
+      "args": ["-y", "tmui-cli", "mcp"]
+    }
+  }
+}
+```
+
+本仓库开发期可指向构建产物：
+
+```json
+{
+  "mcpServers": {
+    "tmui": {
+      "command": "node",
+      "args": ["xui-cli/dist/main.mjs", "mcp"]
+    }
+  }
+}
+```
+
+提供的工具：`create_uniapp_hbx_project`、`create_uniapp_cli_project`、`query_tmui_config`、`list_components`、`get_component_doc`、`query_tmui_doc`。
+
+发布前请先生成文档快照：
+
+```bash
+npm run build:data
+npm run build
+npm run smoke
+```
+