@szc-ft/mcp-szcd-client 0.11.6 → 0.12.1

package/README.md

@@ -0,0 +1,143 @@
+# @szc-ft/mcp-szcd-client
+
+szcd 组件库 MCP 客户端 — 自动配置 AI 编码工具的 MCP 服务器连接、Skills、Agents 和 Commands。
+
+## 安装
+
+```bash
+npm install @szc-ft/mcp-szcd-client
+```
+
+安装后自动执行配置，支持以下 AI 编码工具：
+
+| 工具 | 配置方式 |
+|------|---------|
+| Claude Code | `~/.claude.json` + `~/.claude/agents/` + `~/.claude/skills/` |
+| Trae CLI | `~/.traecli/trae_cli.yaml` |
+| Trae IDE | `~/.trae-cn/mcp.json` + `~/.trae-cn/agents/` |
+| Qoder CLI | `~/.qoder/settings.json` + `~/.qoder/agents/` + `~/.qoder/skills/` |
+| Qwen Code | `~/.qwen/extensions/szcd-component-helper/`（扩展机制） |
+
+## 连接方式
+
+### 方式1: 本地直连 (stdio)
+
+无需远程服务器，每次启动时本地运行 MCP 服务器进程：
+
+```json
+{
+  "mcpServers": {
+    "szcd-component-helper": {
+      "command": "npx",
+      "args": ["szcd-mcp-server", "--stdio"]
+    }
+  }
+}
+```
+
+### 方式2: Streamable HTTP 远程连接（推荐）
+
+连接到远程运行的 MCP 服务器，多客户端共享：
+
+```json
+{
+  "mcpServers": {
+    "szcd-component-helper": {
+      "type": "http",
+      "url": "http://localhost:3456/mcp"
+    }
+  }
+}
+```
+
+### 方式3: SSE 远程连接（旧客户端向后兼容）
+
+```json
+{
+  "mcpServers": {
+    "szcd-component-helper": {
+      "type": "sse",
+      "url": "http://localhost:3456/sse"
+    }
+  }
+}
+```
+
+## CLI 命令
+
+| 命令 | 功能 |
+|------|------|
+| `szcd-mcp-setup` | 运行安装配置（同 `npm run setup`） |
+| `szcd-mcp-update-url [url]` | 更新 MCP 服务器地址并同步所有 IDE 配置 |
+| `szcd-mcp-coding-config` | 配置 CODING 平台连接信息 |
+
+## 智能体（Agent）
+
+提供 `szcd-component-expert` 智能体，帮助开发者查询组件信息、匹配需求到组件、生成基于 szcd 组件库的 React 代码。
+
+各工具自动获取对应详细度的版本：
+
+| 工具 | Agent 版本 | 特点 |
+|------|-----------|------|
+| Claude Code / Qwen | base | 基础工作流，无工具名前缀 |
+| Trae | enhanced | 增强工作流，`mcp__szcd-component-helper__` 工具名前缀 |
+| Qoder | full | 完整工作流 + MCP 工具表 + AskUserQuestion 交互 |
+
+### Agent 构建
+
+Agent 配置采用单一源模板 + 条件标记 + 构建脚本的方案：
+
+```bash
+npm run build:agents
+```
+
+修改 `agents/src/` 下的模板后运行构建，自动生成各平台适配文件。
+
+## Skill
+
+提供 `szcd-component-helper` Skill，包含 22 个 MCP 工具的使用说明。
+
+## 项目结构
+
+```
+├── agents/
+│   ├── src/                        # 源模板（唯一编辑入口）
+│   │   ├── szcd-component-expert.md
+│   │   └── tools.json
+│   ├── platforms.json              # 平台适配配置
+│   ├── build.js                    # 构建脚本
+│   ├── szcd-component-expert.md    # [生成] Claude / Qwen
+│   ├── szcd-component-expert.trae.md # [生成] Trae
+│   └── szcd-component-expert.qoder.md # [生成] Qoder
+├── commands/                       # 自定义命令
+├── skill/                          # Skill 定义
+├── qwen-extension/                 # Qwen Code 扩展包
+├── scripts/
+│   ├── postinstall.js              # 安装入口
+│   ├── update-mcp-url.js           # URL 同步工具
+│   ├── update-coding-config.js     # CODING 配置工具
+│   └── lib/                        # 各平台适配模块
+│       ├── claude-code.js
+│       ├── trae-cli.js
+│       ├── trae-ide.js
+│       ├── qoder.js
+│       ├── qwen-code.js
+│       └── opencode.js
+└── AGENTS.md                       # 项目级指令
+```
+
+## 配置文件
+
+MCP 服务器地址保存在 `~/.szcd-mcp-config.json`：
+
+```json
+{
+  "MCP_SERVER_URL": "http://localhost:3456",
+  "MCP_SERVER_NAME": "szcd-component-helper",
+  "MCP_TIMEOUT": 30000
+}
+```
+
+## License
+
+MIT

package/agents/build.js

@@ -0,0 +1,367 @@
+#!/usr/bin/env node
+
+/**
+ * agents/build.js — 从源模板生成多平台智能体配置文件
+ *
+ * 用法: node agents/build.js
+ *
+ * 逻辑：
+ * 1. 读取 src/ 下的主模板和 tools.json
+ * 2. 读取 platforms.json 平台配置
+ * 3. 将模板整体（含 frontmatter）按 INCLUDE/EXCLUDE 过滤
+ * 4. 替换 {{TOOL:name}} 和 {{MCP_TOOL_TABLE}} 占位符
+ * 5. 写入目标文件
+ * 6. 同步到 mcp-server/agents/ 目录
+ */
+
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const AGENTS_DIR = __dirname;
+const SRC_DIR = path.join(AGENTS_DIR, "src");
+
+// ==================== 工具函数 ====================
+
+/**
+ * 内容级别层级：base < enhanced < full
+ */
+const LEVEL_HIERARCHY = ["base", "enhanced", "full"];
+
+function getLevelIndex(level) {
+    const idx = LEVEL_HIERARCHY.indexOf(level);
+    if (idx === -1) throw new Error(`Unknown content level: ${level}`);
+    return idx;
+}
+
+/**
+ * 按内容级别过滤 INCLUDE/EXCLUDE 段
+ *
+ * 规则：
+ * - 无标记段：所有级别都包含
+ * - <!-- INCLUDE:X --> ... <!-- /INCLUDE:X -->: 仅 levelIndex >= X 的级别包含
+ * - <!-- EXCLUDE:X --> ... <!-- /EXCLUDE:X -->: 仅 levelIndex < X 的级别包含
+ *
+ * 同时处理 frontmatter 中的条件标记（如 <!-- EXCLUDE:enhanced -->tools: ["*"]<!-- /EXCLUDE:enhanced -->）
+ */
+function filterByContentLevel(content, contentLevel) {
+    const levelIndex = getLevelIndex(contentLevel);
+    const lines = content.split("\n");
+    const result = [];
+    let skipStack = []; // { type: 'INCLUDE'|'EXCLUDE', levelIndex }
+
+    for (const line of lines) {
+        // 检查行内标记（前后在同一行）
+        const inlineInclude = line.match(/^(.*)<!--\s*INCLUDE:(\w+)\s*-->(.*?)<!--\s*\/INCLUDE:\2\s*-->(.*)$/);
+        const inlineExclude = line.match(/^(.*)<!--\s*EXCLUDE:(\w+)\s*-->(.*?)<!--\s*\/EXCLUDE:\2\s*-->(.*)$/);
+
+        if (inlineInclude) {
+            const [, before, lvl, inner, after] = inlineInclude;
+            const lvlIdx = getLevelIndex(lvl);
+            if (levelIndex >= lvlIdx) {
+                result.push(before + inner + after);
+            } else {
+                result.push(before + after);
+            }
+            continue;
+        }
+
+        if (inlineExclude) {
+            const [, before, lvl, inner, after] = inlineExclude;
+            const lvlIdx = getLevelIndex(lvl);
+            if (levelIndex < lvlIdx) {
+                result.push(before + inner + after);
+            } else {
+                result.push(before + after);
+            }
+            continue;
+        }
+
+        // 检查块级开始标记
+        const includeStart = line.match(/<!--\s*INCLUDE:(\w+)\s*-->/);
+        const excludeStart = line.match(/<!--\s*EXCLUDE:(\w+)\s*-->/);
+        const includeEnd = line.match(/<!--\s*\/INCLUDE:(\w+)\s*-->/);
+        const excludeEnd = line.match(/<!--\s*\/EXCLUDE:(\w+)\s*-->/);
+
+        if (includeStart) {
+            const lvlIdx = getLevelIndex(includeStart[1]);
+            skipStack.push({ type: "INCLUDE", levelIndex: lvlIdx });
+            continue;
+        }
+
+        if (excludeStart) {
+            const lvlIdx = getLevelIndex(excludeStart[1]);
+            skipStack.push({ type: "EXCLUDE", levelIndex: lvlIdx });
+            continue;
+        }
+
+        if (includeEnd || excludeEnd) {
+            skipStack.pop();
+            continue;
+        }
+
+        // 判断当前行是否应该跳过
+        let shouldSkip = false;
+        for (const rule of skipStack) {
+            if (rule.type === "INCLUDE" && levelIndex < rule.levelIndex) {
+                shouldSkip = true;
+                break;
+            }
+            if (rule.type === "EXCLUDE" && levelIndex >= rule.levelIndex) {
+                shouldSkip = true;
+                break;
+            }
+        }
+
+        if (!shouldSkip) {
+            result.push(line);
+        }
+    }
+
+    return result.join("\n");
+}
+
+/**
+ * 替换 {{TOOL:name}} 占位符
+ */
+function replaceToolPlaceholders(content, toolPrefix) {
+    return content.replace(/\{\{TOOL:(\w+)\}\}/g, (_match, toolName) => {
+        return toolPrefix ? `${toolPrefix}${toolName}` : toolName;
+    });
+}
+
+/**
+ * 从 tools.json 生成 MCP 工具表格
+ * 按功能分组，同一 whenToUse 的工具合并在一行
+ */
+function generateMcpToolTable(tools, toolPrefix) {
+    const rows = [];
+    const grouped = new Map();
+
+    for (const tool of tools) {
+        const key = tool.whenToUse;
+        if (!grouped.has(key)) {
+            grouped.set(key, []);
+        }
+        grouped.get(key).push(tool);
+    }
+
+    for (const [, group] of grouped) {
+        const names = group.map((t) => {
+            const fullName = toolPrefix ? `${toolPrefix}${t.name}` : t.name;
+            return `\`${fullName}\``;
+        });
+        rows.push(`| ${names.join(" / ")} | ${group[0].description} | ${group[0].whenToUse} |`);
+    }
+
+    const header = "| 工具名 | 功能 | 何时使用 |\n|--------|------|---------|";
+    return header + "\n" + rows.join("\n");
+}
+
+/**
+ * 从 frontmatter 中移除指定字段
+ */
+function stripFrontmatterFields(content, fields) {
+    const fmMatch = content.match(/^(---\n)([\s\S]*?)(\n---)/);
+    if (!fmMatch) return content;
+
+    const prefix = fmMatch[1];
+    let fmBody = fmMatch[2];
+    const suffix = fmMatch[3];
+
+    for (const field of fields) {
+        // 匹配字段行（支持简单值、多行值、YAML列表等）
+        // 简单行：tools: ["*"]
+        // YAML列表：tools:\n  - "*"
+        const simpleLineRegex = new RegExp(`^${field}:.*$\\n?`, "m");
+        fmBody = fmBody.replace(simpleLineRegex, "");
+
+        const yamlListRegex = new RegExp(`^${field}:\\s*\\n(?:^\\s+.*$\\n?)*`, "m");
+        fmBody = fmBody.replace(yamlListRegex, "");
+    }
+
+    // 清理空行
+    fmBody = fmBody.replace(/\n{2,}/g, "\n");
+
+    return prefix + fmBody + suffix + content.slice(fmMatch[0].length);
+}
+
+/**
+ * 清理输出内容中的多余空行和残留空行
+ */
+function cleanupContent(content) {
+    // 移除连续3个以上空行 → 2个空行
+    let result = content.replace(/\n{4,}/g, "\n\n\n");
+    // 移除 frontmatter 后多余空行（--- 后最多1个空行）
+    result = result.replace(/(---\n)\n{2,}/g, "$1\n");
+    return result;
+}
+
+// ==================== 主构建逻辑 ====================
+
+function build() {
+    console.log("🔧 Building agent configurations...\n");
+
+    // 1. 读取源文件
+    const templatePath = path.join(SRC_DIR, "szcd-component-expert.md");
+    const toolsPath = path.join(SRC_DIR, "tools.json");
+    const platformsPath = path.join(AGENTS_DIR, "platforms.json");
+
+    const templateContent = fs.readFileSync(templatePath, "utf8");
+    const tools = JSON.parse(fs.readFileSync(toolsPath, "utf8"));
+    const platformsConfig = JSON.parse(fs.readFileSync(platformsPath, "utf8"));
+
+    // 2. 按平台生成
+    for (const [platformName, platformConfig] of Object.entries(platformsConfig.platforms)) {
+        console.log(`  Generating for ${platformName} (level: ${platformConfig.contentLevel})...`);
+
+        // 对整个模板内容（含 frontmatter）进行条件过滤
+        let filtered = filterByContentLevel(templateContent, platformConfig.contentLevel);
+
+        // 剥离 frontmatter 中指定字段（如 Qwen 不需要 tools/model/type）
+        if (platformConfig.stripFrontmatterFields && platformConfig.stripFrontmatterFields.length > 0) {
+            filtered = stripFrontmatterFields(filtered, platformConfig.stripFrontmatterFields);
+        }
+
+        // 替换 {{TOOL:}} 占位符
+        filtered = replaceToolPlaceholders(filtered, platformConfig.toolPrefix);
+
+        // 替换 {{MCP_TOOL_TABLE}}
+        if (filtered.includes("{{MCP_TOOL_TABLE}}")) {
+            const table = generateMcpToolTable(tools, platformConfig.toolPrefix);
+            filtered = filtered.replace("{{MCP_TOOL_TABLE}}", table);
+        }
+
+        // 清理
+        const output = cleanupContent(filtered);
+
+        // 确定输出路径
+        const outputDir = platformConfig.outputDir
+            ? path.join(AGENTS_DIR, platformConfig.outputDir)
+            : AGENTS_DIR;
+        const outputPath = path.join(outputDir, platformConfig.outputFile);
+
+        if (!fs.existsSync(outputDir)) {
+            fs.mkdirSync(outputDir, { recursive: true });
+        }
+
+        fs.writeFileSync(outputPath, output);
+        console.log(`    ✓ Written: ${path.relative(AGENTS_DIR, outputPath)}`);
+    }
+
+    // 3. 同步到 mcp-server/agents/（同级 mcp/szcd-mcp-server 目录）
+    const mcpServerAgentsDir = path.join(AGENTS_DIR, "..", "..", "szcd-mcp-server", "agents");
+    if (fs.existsSync(path.dirname(mcpServerAgentsDir))) {
+        if (!fs.existsSync(mcpServerAgentsDir)) {
+            fs.mkdirSync(mcpServerAgentsDir, { recursive: true });
+        }
+
+        const outputFiles = [
+            "szcd-component-expert.md",
+            "szcd-component-expert.trae.md",
+            "szcd-component-expert.qoder.md",
+        ];
+        for (const file of outputFiles) {
+            const src = path.join(AGENTS_DIR, file);
+            const dest = path.join(mcpServerAgentsDir, file);
+            if (fs.existsSync(src)) {
+                fs.copyFileSync(src, dest);
+                console.log(`    ✓ Synced to mcp-server: ${file}`);
+            }
+        }
+    }
+
+    // 4. 同步到 qwen-extension/agents/（供 Qwen Code 扩展安装使用）
+    const qwenExtDir = path.join(AGENTS_DIR, "..", "qwen-extension");
+    const qwenGeneratedAgent = path.join(AGENTS_DIR, "qwen-extension", "agents", "szcd-component-expert.md");
+    if (fs.existsSync(qwenGeneratedAgent)) {
+        const qwenExtAgentsDir = path.join(qwenExtDir, "agents");
+        if (!fs.existsSync(qwenExtAgentsDir)) {
+            fs.mkdirSync(qwenExtAgentsDir, { recursive: true });
+        }
+        fs.copyFileSync(qwenGeneratedAgent, path.join(qwenExtAgentsDir, "szcd-component-expert.md"));
+        console.log(`    ✓ Synced to qwen-extension/agents/`);
+    }
+
+    // 5. 同步 SKILL.md 和 commands 到 qwen-extension/
+    const packageRoot = path.join(AGENTS_DIR, "..");
+
+    // 同步 SKILL.md
+    const skillSource = path.join(packageRoot, "skill", "SKILL.md");
+    const skillDest = path.join(qwenExtDir, "skills", "szcd-component-helper", "SKILL.md");
+    if (fs.existsSync(skillSource)) {
+        if (!fs.existsSync(path.dirname(skillDest))) {
+            fs.mkdirSync(path.dirname(skillDest), { recursive: true });
+        }
+        fs.copyFileSync(skillSource, skillDest);
+        console.log(`    ✓ Synced to qwen-extension/skills/`);
+    }
+
+    // 同步 commands
+    const commandsSourceDir = path.join(packageRoot, "commands");
+    const commandsDestDir = path.join(qwenExtDir, "commands");
+    if (fs.existsSync(commandsSourceDir)) {
+        if (!fs.existsSync(commandsDestDir)) {
+            fs.mkdirSync(commandsDestDir, { recursive: true });
+        }
+        const cmdFiles = fs.readdirSync(commandsSourceDir).filter((f) => f.endsWith(".md"));
+        for (const cmdFile of cmdFiles) {
+            fs.copyFileSync(
+                path.join(commandsSourceDir, cmdFile),
+                path.join(commandsDestDir, cmdFile),
+            );
+        }
+        if (cmdFiles.length > 0) {
+            console.log(`    ✓ Synced ${cmdFiles.length} command(s) to qwen-extension/commands/`);
+        }
+    }
+
+    // 6. 生成 qwen-extension.json（MCP 配置从 platforms.json 读取）
+    const qwenConfig = platformsConfig.platforms.qwen;
+    if (qwenConfig && qwenConfig.mcp) {
+        const manifestPath = path.join(qwenExtDir, "qwen-extension.json");
+        const pkgJsonPath = path.join(packageRoot, "package.json");
+        const pkgVersion = JSON.parse(fs.readFileSync(pkgJsonPath, "utf8")).version;
+
+        const manifest = {
+            name: platformsConfig.mcpServerName,
+            version: pkgVersion,
+            description: "szcd 组件库 MCP 助手 — 查询组件信息、匹配需求、生成代码",
+            mcpServers: {
+                [platformsConfig.mcpServerName]: {
+                    type: qwenConfig.mcp.type,
+                    url: qwenConfig.mcp.url,
+                },
+            },
+            contextFileName: "QWEN.md",
+            commands: "commands",
+            skills: "skills",
+            agents: "agents",
+            settings: [
+                {
+                    name: "MCP Server URL",
+                    description: "szcd MCP 服务器地址（默认 http://localhost:3456）",
+                    envVar: "MCP_SERVER_URL",
+                    sensitive: false,
+                },
+            ],
+            excludeTools: [],
+        };
+
+        fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 4) + "\n");
+        console.log(`    ✓ Generated qwen-extension.json (type: ${qwenConfig.mcp.type}, url: ${qwenConfig.mcp.url})`);
+    }
+
+    console.log("\n✅ Agent build complete!");
+}
+
+try {
+    build();
+} catch (error) {
+    console.error("❌ Build failed:", error.message);
+    console.error(error.stack);
+    process.exit(1);
+}

package/agents/platforms.json

@@ -0,0 +1,51 @@
+{
+    "mcpServerName": "szcd-component-helper",
+    "platforms": {
+        "claude": {
+            "outputFile": "szcd-component-expert.md",
+            "contentLevel": "base",
+            "frontmatter": {
+                "name": "{{name}}",
+                "description": "{{description}}",
+                "tools": "[\"*\"]",
+                "model": "sonnet",
+                "type": "agent"
+            },
+            "toolPrefix": ""
+        },
+        "trae": {
+            "outputFile": "szcd-component-expert.trae.md",
+            "contentLevel": "enhanced",
+            "frontmatter": {
+                "name": "{{name}}",
+                "tools": "- \"*\"",
+                "description": "{{description}}"
+            },
+            "toolPrefix": "mcp__szcd-component-helper__"
+        },
+        "qoder": {
+            "outputFile": "szcd-component-expert.qoder.md",
+            "contentLevel": "full",
+            "frontmatter": {
+                "name": "{{name}}",
+                "description": "{{description}}"
+            },
+            "toolPrefix": ""
+        },
+        "qwen": {
+            "outputFile": "szcd-component-expert.md",
+            "outputDir": "qwen-extension/agents",
+            "contentLevel": "base",
+            "frontmatter": {
+                "name": "{{name}}",
+                "description": "{{description}}"
+            },
+            "stripFrontmatterFields": ["tools", "model", "type"],
+            "toolPrefix": "",
+            "mcp": {
+                "type": "http",
+                "url": "http://localhost:3456/mcp"
+            }
+        }
+    }
+}