@ppdocs/mcp 3.2.37 → 3.3.0

package/templates/hooks/hook.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-Claude Code Hook - 动态规则触发
-GET /rules-meta → 关键词匹配 → POST /rules/batch 批量获取
+Claude Code Hook - 动态工作流触发
+GET /workflows → 关键词匹配 → POST /workflows/batch 批量获取 Markdown 工作流
 兼容 Python 2.7+ / 3.x，支持 Windows / macOS / Linux
 """
 
@@ -123,14 +123,14 @@ def api_post(api_base, project_id, key, path, body):
     return None
 
 
-def fetch_rules_meta(api_base, project_id, key):
-    """获取规则触发配置"""
-    return api_get(api_base, project_id, key, "/rules-meta") or {}
+def fetch_workflows(api_base, project_id, key):
+    """获取可用工作流摘要"""
+    return api_get(api_base, project_id, key, "/workflows") or []
 
 
-def fetch_rules_batch(api_base, project_id, key, types):
-    """批量获取多个规则类型的内容"""
-    return api_post(api_base, project_id, key, "/rules/batch", types) or {}
+def fetch_workflows_batch(api_base, project_id, key, items):
+    """批量获取工作流正文"""
+    return api_post(api_base, project_id, key, "/workflows/batch", items) or []
 
 
 # ╔══════════════════════════════════════════════════════════════╗
@@ -143,27 +143,36 @@ def count_hits(text, keywords):
     return sum(1 for kw in keywords if kw.lower() in text)
 
 
-def match_all(text, meta):
-    """匹配所有触发的规则类型，返回 [(rule_type, label), ...]"""
+def match_all(text, workflows):
+    """匹配所有触发的工作流，返回工作流摘要列表"""
     matched = []
-    for rule_type, config in meta.items():
-        if config.get("always"):
-            matched.append((rule_type, config.get("label", rule_type)))
+    for wf in workflows:
+        if wf.get("always"):
+            matched.append(wf)
             continue
-        keywords = config.get("keywords", [])
-        min_hits = config.get("min_hits", 1)
+        keywords = wf.get("keywords", [])
+        min_hits = wf.get("minHits", 1)
         if keywords and count_hits(text, keywords) >= min_hits:
-            matched.append((rule_type, config.get("label", rule_type)))
+            matched.append(wf)
     return matched
 
 
-def format_rules(items, label):
-    """格式化规则输出"""
-    if not items:
+def format_workflow(item):
+    """格式化工作流输出"""
+    content = item.get("content", "")
+    if not content:
         return ""
-    lines = ["# %s\n" % label]
-    for item in items:
-        lines.append("- %s" % item)
+    lines = ["# %s" % item.get("title", item.get("id", "workflow"))]
+    meta = []
+    if item.get("scope"):
+        meta.append("scope=%s" % item.get("scope"))
+    if item.get("system"):
+        meta.append("system=%s" % item.get("system"))
+    if meta:
+        lines.append("")
+        lines.append("> %s" % " | ".join(meta))
+    lines.append("")
+    lines.append(content)
     return "\n".join(lines)
 
 
@@ -204,27 +213,35 @@ def main():
     if not project_id or not key:
         return
 
-    # 从服务器获取触发配置
-    meta = fetch_rules_meta(api_base, project_id, key)
-    if not meta:
+    # 从服务器获取工作流摘要
+    workflows = fetch_workflows(api_base, project_id, key)
+    if not workflows:
         return
 
-    # 匹配所有触发的规则
-    matched = match_all(user_input_lower, meta)
+    # 匹配所有触发的工作流
+    matched = match_all(user_input_lower, workflows)
     if not matched:
         return
 
-    # 批量获取所有命中的规则内容 (单次请求)
-    type_list = [rule_type for rule_type, _ in matched]
-    label_map = {rule_type: label for rule_type, label in matched}
-    batch = fetch_rules_batch(api_base, project_id, key, type_list)
+    # 批量获取所有命中的工作流正文
+    selectors = [{"id": wf.get("id", ""), "scope": wf.get("scope", "")} for wf in matched if wf.get("id")]
+    batch = fetch_workflows_batch(api_base, project_id, key, selectors)
+    if not batch:
+        return
+
+    batch_map = {}
+    for item in batch:
+        batch_map["%s:%s" % (item.get("scope", ""), item.get("id", ""))] = item
 
     # 按匹配顺序格式化输出
     output_parts = []
-    for rule_type in type_list:
-        rules = batch.get(rule_type, [])
-        if rules:
-            output_parts.append(format_rules(rules, label_map[rule_type]))
+    for wf in matched:
+        key_name = "%s:%s" % (wf.get("scope", ""), wf.get("id", ""))
+        item = batch_map.get(key_name)
+        if item:
+            rendered = format_workflow(item)
+            if rendered:
+                output_parts.append(rendered)
 
     if output_parts:
         print("\n\n".join(output_parts))

package/templates/kiro-rules/ppdocs.md

@@ -12,9 +12,10 @@ kg_discuss(action:"list") -> ???????
 ## 1. ????????
 
 - ??: `kg_flowchart(action:"list|get|get_node|update_node|delete_node|batch_add|bind|unbind|orphans|health|create_chart|delete_chart")`
-- ??: `kg_rules(action:"get|save|get_meta|save_meta")`
+- ??: `kg_workflow()` / `kg_workflow(id:"...")` / `kg_workflow(action:"save|delete")`
 - ??: `kg_task(action:"create|get|update|archive|delete")`
 - ??: `kg_files(action:"list|read|upload|download|public_*")`
+- ??: `kg_ref(action:"list|get|save|delete|read_file")`
 - ??/??: `kg_discuss(...)`, `kg_meeting(...)`
 - ????: `code_scan()`, `code_smart_context(symbolName)`, `code_full_path(symbolA, symbolB)`
 - ????: ?????????????????????????????? fallback????????????
@@ -22,7 +23,7 @@ kg_discuss(action:"list") -> ???????
 ## 2. ?????
 
 ### Step 1: ????
-1. ?? `kg_flowchart(get)` ????????? `kg_rules(get)` ?????
+1. ?? `kg_flowchart(get)` ????????? `kg_workflow()` ?????
 2. ???????? `kg_flowchart(get_node, expand:2, includeDoc:true, includeFiles:true)`?
 3. ????? `subFlowchart`???????????????
 4. ??????????? `code_scan()`??? `code_smart_context` / `code_full_path`?

package/dist/sync/beacon.d.ts

@@ -1,26 +0,0 @@
-export declare class SyncBeacon {
-    private cwd;
-    private projectId;
-    private debounceMs;
-    private watcher;
-    private isSyncing;
-    private pendingSync;
-    private debounceTimer;
-    constructor(cwd: string, projectId: string, debounceMs?: number);
-    /**
-     * 启动同步引擎
-     */
-    start(): void;
-    /**
-     * 停止同步引擎
-     */
-    stop(): void;
-    /**
-     * 触发同步计算
-     */
-    private triggerSync;
-    /**
-     * 核心: 打包并推送全量快照
-     */
-    private performSync;
-}

package/dist/sync/beacon.js

@@ -1,186 +0,0 @@
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
-import archiver from 'archiver';
-import * as chokidar from 'chokidar';
-import { getClient } from '../storage/httpClient.js';
-// 需要排除的大文件/敏感目录
-const EXCLUDED_DIRS = [
-    'node_modules',
-    '.git',
-    '.next',
-    'dist',
-    'build',
-    'out',
-    'target',
-    '__pycache__',
-    '.venv',
-    'venv',
-    '.idea',
-    '.vscode',
-    '.vs',
-    '.ppdocs',
-    '.cursor',
-    '.claude',
-    '.gemini',
-];
-export class SyncBeacon {
-    cwd;
-    projectId;
-    debounceMs;
-    watcher = null;
-    isSyncing = false;
-    pendingSync = false;
-    debounceTimer = null;
-    constructor(cwd, projectId, debounceMs = 15000 // 默认 15 秒防抖
-    ) {
-        this.cwd = cwd;
-        this.projectId = projectId;
-        this.debounceMs = debounceMs;
-    }
-    /**
-     * 启动同步引擎
-     */
-    start() {
-        if (this.watcher)
-            return;
-        console.error(`[Code Beacon] Started monitoring project: ${this.projectId}`);
-        // [M1 修复] 首次启动延迟 3 秒，让 MCP 工具注册和事件循环先稳定
-        setTimeout(() => this.triggerSync(), 3000);
-        // 配置监听器
-        this.watcher = chokidar.watch(this.cwd, {
-            ignored: (filePath) => {
-                const basename = path.basename(filePath);
-                if (EXCLUDED_DIRS.includes(basename))
-                    return true;
-                if (basename.startsWith('.') && basename !== '.env.example' && !filePath.includes('.cursorrules') && !filePath.includes('ppdocs.md'))
-                    return true;
-                return false;
-            },
-            persistent: true,
-            ignoreInitial: true,
-        });
-        // 绑定事件
-        const scheduleSync = (evt, p) => {
-            if (this.debounceTimer) {
-                clearTimeout(this.debounceTimer);
-            }
-            this.debounceTimer = setTimeout(() => {
-                console.error(`[Code Beacon] Changes detected (${evt}: ${path.basename(p)}), scheduling sync...`);
-                this.triggerSync();
-            }, this.debounceMs);
-        };
-        this.watcher
-            .on('add', (p) => scheduleSync('add', p))
-            .on('change', (p) => scheduleSync('change', p))
-            .on('unlink', (p) => scheduleSync('delete', p))
-            .on('unlinkDir', (p) => scheduleSync('delete dir', p));
-    }
-    /**
-     * 停止同步引擎
-     */
-    stop() {
-        if (this.debounceTimer) {
-            clearTimeout(this.debounceTimer);
-            this.debounceTimer = null;
-        }
-        if (this.watcher) {
-            this.watcher.close();
-            this.watcher = null;
-            console.error(`[Code Beacon] Stopped monitoring project: ${this.projectId}`);
-        }
-    }
-    /**
-     * 触发同步计算
-     */
-    async triggerSync() {
-        if (this.isSyncing) {
-            this.pendingSync = true;
-            return;
-        }
-        this.isSyncing = true;
-        this.pendingSync = false;
-        try {
-            await this.performSync();
-        }
-        catch (error) {
-            console.error(`[Code Beacon] Sync error:`, error);
-        }
-        finally {
-            this.isSyncing = false;
-            if (this.pendingSync) {
-                this.triggerSync();
-            }
-        }
-    }
-    /**
-     * 核心: 打包并推送全量快照
-     */
-    async performSync() {
-        // [C3 修复] getClient() 在未初始化时 throw，不会返回 null
-        let client;
-        try {
-            client = getClient();
-        }
-        catch {
-            console.warn('[Code Beacon] API Client not ready, skipping sync.');
-            return;
-        }
-        return new Promise((resolve, reject) => {
-            try {
-                // 使用系统临时目录存放打包文件，避免 .ppdocs（是配置文件非目录）冲突
-                const tmpFile = path.join(os.tmpdir(), `beacon-${this.projectId}-${Date.now()}.zip`);
-                const output = fs.createWriteStream(tmpFile);
-                const archive = archiver('zip', {
-                    zlib: { level: 3 } // 低压缩率，追求速度
-                });
-                // [C1 修复] 监听 WriteStream 的 error 事件，防止 Node 进程崩溃
-                output.on('error', (err) => {
-                    console.error('[Code Beacon] WriteStream error:', err);
-                    reject(err);
-                });
-                output.on('close', async () => {
-                    try {
-                        const data = await fs.promises.readFile(tmpFile);
-                        // [C2 修复] 使用本项目标准上传接口，而非 crossUploadFiles
-                        await client.uploadRawZip(data);
-                        console.error(`[Code Beacon] Snapshot synced: ${archive.pointer()} bytes`);
-                    }
-                    catch (e) {
-                        console.error('[Code Beacon] Upload failed:', e);
-                    }
-                    finally {
-                        try {
-                            if (fs.existsSync(tmpFile))
-                                fs.promises.unlink(tmpFile);
-                        }
-                        catch { }
-                        resolve();
-                    }
-                });
-                archive.on('error', (err) => {
-                    reject(err);
-                });
-                archive.pipe(output);
-                // 遍历所有非隐藏、非排除的文件打包
-                archive.glob('**/*', {
-                    cwd: this.cwd,
-                    ignore: [
-                        ...EXCLUDED_DIRS.map(d => `${d}/**`),
-                        '.ppdocs',
-                        '.*'
-                    ],
-                    dot: false
-                });
-                // [A2 修复] 排除 .env（敏感凭证），仅包含安全的 IDE 配置
-                if (fs.existsSync(path.join(this.cwd, '.cursorrules'))) {
-                    archive.file(path.join(this.cwd, '.cursorrules'), { name: '.cursorrules' });
-                }
-                archive.finalize();
-            }
-            catch (err) {
-                reject(err);
-            }
-        });
-    }
-}

package/dist/tools/rules.d.ts

@@ -1,7 +0,0 @@
-/**
- * 📏 kg_rules
- * 统一规则入口: get | save | get_meta | save_meta | delete
- */
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-import { type McpContext } from './shared.js';
-export declare function registerRuleTools(server: McpServer, ctx: McpContext): void;

package/dist/tools/rules.js

@@ -1,120 +0,0 @@
-/**
- * 📏 kg_rules
- * 统一规则入口: get | save | get_meta | save_meta | delete
- */
-import { z } from 'zod';
-import { getClient } from '../storage/httpClient.js';
-import { decodeObjectStrings, getRules, RULE_TYPE_LABELS } from '../utils.js';
-import { wrap, safeTool, crossPrefix } from './shared.js';
-export function registerRuleTools(server, ctx) {
-    const client = () => getClient();
-    server.tool('kg_rules', '📏 项目规则管理 — 读取或保存代码风格、审查规则等。action: get(读取规则)|save(保存规则)|get_meta(读取触发配置)|save_meta(保存触发配置)', {
-        action: z.enum(['get', 'save', 'get_meta', 'save_meta', 'delete'])
-            .describe('操作类型'),
-        ruleType: z.string().optional()
-            .describe('规则类型(如 userStyles, codeStyle, reviewRules)。get/save 时使用，不传则获取全部'),
-        rules: z.array(z.string()).optional()
-            .describe('save 时的规则数组'),
-        meta: z.record(z.string(), z.object({
-            label: z.string().describe('规则显示名称'),
-            keywords: z.array(z.string()).default([]).describe('触发关键词列表'),
-            min_hits: z.number().default(1).describe('最低触发关键词数'),
-            always: z.boolean().default(false).describe('是否始终触发')
-        })).optional().describe('save_meta 时的触发配置映射'),
-        targetProject: z.string().optional()
-            .describe('跨项目读取 (get)'),
-    }, async (args) => safeTool(async () => {
-        const decoded = decodeObjectStrings(args);
-        switch (decoded.action) {
-            case 'get': {
-                if (decoded.targetProject) {
-                    const crossMeta = await client().crossGetRulesMeta(decoded.targetProject);
-                    if (decoded.ruleType) {
-                        const rules = await client().crossGetRules(decoded.targetProject, decoded.ruleType);
-                        if (rules.length === 0) {
-                            const label = crossMeta[decoded.ruleType]?.label || decoded.ruleType;
-                            return wrap(`暂无${label}规则(项目: ${decoded.targetProject})`);
-                        }
-                        return wrap(`${crossPrefix(decoded.targetProject)}${rules.join('\n')}`);
-                    }
-                    const types = Object.keys(crossMeta).length > 0 ? Object.keys(crossMeta) : Object.keys(RULE_TYPE_LABELS);
-                    const allRules = [];
-                    for (const type of types) {
-                        const rules = await client().crossGetRules(decoded.targetProject, type);
-                        if (rules.length > 0) {
-                            const label = crossMeta[type]?.label || RULE_TYPE_LABELS[type] || type;
-                            allRules.push(`## ${label}\n${rules.join('\n')}`);
-                        }
-                    }
-                    if (allRules.length === 0)
-                        return wrap(`暂无项目规则(项目: ${decoded.targetProject})`);
-                    return wrap(`${crossPrefix(decoded.targetProject)}${allRules.join('\n\n')}`);
-                }
-                const rules = await getRules(ctx.projectId, decoded.ruleType || undefined);
-                if (!rules || rules.trim() === '') {
-                    const meta = await client().getRulesMeta();
-                    const typeName = decoded.ruleType ? (meta[decoded.ruleType]?.label || decoded.ruleType) : '项目';
-                    return wrap(`暂无${typeName}规则`);
-                }
-                return wrap(rules);
-            }
-            case 'save': {
-                if (!decoded.ruleType)
-                    return wrap('❌ save 需要 ruleType');
-                if (!decoded.rules)
-                    return wrap('❌ save 需要 rules 数组');
-                const existing = await client().getRulesApi(decoded.ruleType);
-                const existingSet = new Set(existing.map(r => r.trim()));
-                const toAdd = decoded.rules.filter((r) => !existingSet.has(r.trim()));
-                const merged = [...existing, ...toAdd];
-                const success = await client().saveRulesApi(decoded.ruleType, merged);
-                if (!success)
-                    return wrap('❌ 保存失败');
-                const meta = await client().getRulesMeta();
-                const label = meta[decoded.ruleType]?.label || decoded.ruleType;
-                return wrap(`✅ ${label}已保存 (新增${toAdd.length}条, 共${merged.length}条)`);
-            }
-            case 'get_meta': {
-                const meta = await client().getRulesMeta();
-                if (Object.keys(meta).length === 0)
-                    return wrap('暂无规则配置');
-                const lines = Object.entries(meta).map(([type, m]) => {
-                    const kw = m.keywords.length > 0 ? m.keywords.join(', ') : '(无)';
-                    const trigger = m.always ? '始终触发' : `关键词≥${m.min_hits}: ${kw}`;
-                    return `- **${m.label}** (${type}): ${trigger}`;
-                });
-                return wrap(`规则触发配置:\n\n${lines.join('\n')}`);
-            }
-            case 'save_meta': {
-                if (!decoded.meta)
-                    return wrap('❌ save_meta 需要 meta');
-                const existing = await client().getRulesMeta();
-                const merged = { ...existing, ...decoded.meta };
-                const success = await client().saveRulesMeta(merged);
-                if (!success)
-                    return wrap('❌ 保存失败');
-                return wrap(`✅ 触发配置已保存 (更新${Object.keys(decoded.meta).length}个类型, 共${Object.keys(merged).length}个类型)`);
-            }
-            case 'delete': {
-                if (!decoded.ruleType)
-                    return wrap('❌ delete 需要 ruleType');
-                if (!decoded.rules || decoded.rules.length === 0)
-                    return wrap('❌ delete 需要 rules 数组(要删除的规则内容)');
-                const existing = await client().getRulesApi(decoded.ruleType);
-                const toDelete = new Set(decoded.rules.map((r) => r.trim()));
-                const filtered = existing.filter((r) => !toDelete.has(r.trim()));
-                const removed = existing.length - filtered.length;
-                if (removed === 0)
-                    return wrap('ℹ️ 未找到匹配的规则');
-                const success = await client().saveRulesApi(decoded.ruleType, filtered);
-                if (!success)
-                    return wrap('❌ 删除失败');
-                const meta = await client().getRulesMeta();
-                const label = meta[decoded.ruleType]?.label || decoded.ruleType;
-                return wrap(`✅ ${label}: 已删除${removed}条, 剩余${filtered.length}条`);
-            }
-            default:
-                return wrap(`❌ 未知 action: ${decoded.action}`);
-        }
-    }));
-}