Back to Details

skill-sync

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Purpose

用途

Keeps AGENTS.md Auto-invoke sections in sync with skill metadata. When you create or modify a skill, run the sync script to automatically update all affected AGENTS.md files.
保持AGENTS.md的自动调用章节与Skill元数据同步。当你创建或修改Skill时，运行同步脚本即可自动更新所有受影响的AGENTS.md文件。

Required Skill Metadata

所需Skill元数据

Each skill that should appear in Auto-invoke sections needs these fields in 
metadata
.
auto_invoke
can be either a single string or a list of actions:
yaml
metadata:
  author: prowler-cloud
  version: "1.0"
  scope: [ui]                                    # Which AGENTS.md: ui, api, sdk, root

  # Option A: single action
  auto_invoke: "Creating/modifying components"

  # Option B: multiple actions
  # auto_invoke:
  #   - "Creating/modifying components"
  #   - "Refactoring component folder placement"
所有需要出现在自动调用章节中的Skill，其
metadata
中必须包含以下字段。
auto_invoke
可以是单个字符串或一个动作列表：
yaml
metadata:
  author: prowler-cloud
  version: "1.0"
  scope: [ui]                                    # Which AGENTS.md: ui, api, sdk, root

  # Option A: single action
  auto_invoke: "Creating/modifying components"

  # Option B: multiple actions
  # auto_invoke:
  #   - "Creating/modifying components"
  #   - "Refactoring component folder placement"

Scope Values

Scope 取值

ScopeUpdates
root
AGENTS.md
(repo root)
ui
ui/AGENTS.md
api
api/AGENTS.md
sdk
prowler/AGENTS.md
mcp_server
mcp_server/AGENTS.md
Skills can have multiple scopes: 
scope: [ui, api]
Scope更新目标
root
AGENTS.md
(仓库根目录)
ui
ui/AGENTS.md
api
api/AGENTS.md
sdk
prowler/AGENTS.md
mcp_server
mcp_server/AGENTS.md
Skills可包含多个scope：
scope: [ui, api]

Usage

使用方法

After Creating/Modifying a Skill

创建/修改Skill后

bash
./skills/skill-sync/assets/sync.sh
bash
./skills/skill-sync/assets/sync.sh

What It Does

脚本功能

  1. Reads all 
    skills/*/SKILL.md
    files
  2. Extracts 
    metadata.scope
    and 
    metadata.auto_invoke
  3. Generates Auto-invoke tables for each AGENTS.md
  4. Updates the 
    ### Auto-invoke Skills
    section in each file
  1. 读取所有
    skills/*/SKILL.md
    文件
  2. 提取
    metadata.scope
    和
    metadata.auto_invoke
    信息
  3. 为每个AGENTS.md生成自动调用表格
  4. 更新每个文件中的
    ### Auto-invoke Skills
    章节

Example

示例

Given this skill metadata:
yaml
undefined
假设存在如下Skill元数据：
yaml
undefined

skills/prowler-ui/SKILL.md

skills/prowler-ui/SKILL.md

metadata: author: prowler-cloud version: "1.0" scope: [ui] auto_invoke: "Creating/modifying React components"

The sync script generates in `ui/AGENTS.md`:

```markdown
metadata: author: prowler-cloud version: "1.0" scope: [ui] auto_invoke: "Creating/modifying React components"

同步脚本会在`ui/AGENTS.md`中生成如下内容：

```markdown

Auto-invoke Skills

Auto-invoke Skills

When performing these actions, ALWAYS invoke the corresponding skill FIRST:
ActionSkill
Creating/modifying React components
prowler-ui

---
When performing these actions, ALWAYS invoke the corresponding skill FIRST:
ActionSkill
Creating/modifying React components
prowler-ui

---

Commands

命令说明

bash
undefined
bash
undefined

Sync all AGENTS.md files

同步所有AGENTS.md文件

./skills/skill-sync/assets/sync.sh
./skills/skill-sync/assets/sync.sh

Dry run (show what would change)

试运行（显示将会做出的更改）

./skills/skill-sync/assets/sync.sh --dry-run
./skills/skill-sync/assets/sync.sh --dry-run

Sync specific scope only

仅同步指定scope

./skills/skill-sync/assets/sync.sh --scope ui

---
./skills/skill-sync/assets/sync.sh --scope ui

---

Checklist After Modifying Skills

修改Skill后的检查清单

  • Added 
    metadata.scope
    to new/modified skill
  • Added 
    metadata.auto_invoke
    with action description
  • Ran 
    ./skills/skill-sync/assets/sync.sh
  • Verified AGENTS.md files updated correctly
  • 为新建/修改的Skill添加
    metadata.scope
    字段
  • 添加带有动作描述的
    metadata.auto_invoke
    字段
  • 运行
    ./skills/skill-sync/assets/sync.sh
    脚本
  • 验证AGENTS.md文件已正确更新