Back to Details

sync-plugin-skills

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Sync Plugin Skills

同步插件技能

Synchronize plugin skills with the current implementation and documentation.
将插件技能与当前代码实现及文档保持同步。

Purpose

用途

Ensure that skills in 
plugins/synapse-a2a/skills/
accurately reflect:
  • Current implementation in 
    synapse/
    directory
  • README.md documentation
  • Guides in 
    guides/
    folder
确保
plugins/synapse-a2a/skills/
中的技能内容准确匹配：
  • synapse/
    目录下的当前代码实现
  • README.md文档内容
  • guides/
    文件夹中的指南文档

When to Use

使用场景

  • After implementing new features or parameters
  • After updating README.md or guides
  • Before releasing a new version
  • When 
    /sync-plugin-skills
    is invoked
  • 在实现新功能或参数后
  • 在更新README.md或指南文档后
  • 在发布新版本前
  • 当调用
    /sync-plugin-skills
    命令时

Workflow

工作流程

Step 1: Gather Current State

步骤1：收集当前状态

Read the following files to understand current implementation and documentation:
  1. Implementation: Key files in 
    synapse/
    • synapse/tools/a2a.py
      - CLI tool implementation
    • synapse/a2a_client.py
      - A2A client
    • synapse/cli.py
      - Main CLI entry point
    • synapse/commands/*.py
      - Command implementations
  2. Documentation:
    • README.md
      - Main documentation
    • guides/usage.md
      - Usage guide
    • guides/settings.md
      - Settings documentation
  3. Current Skills:
    • plugins/synapse-a2a/skills/synapse-a2a/SKILL.md
    • plugins/synapse-a2a/skills/synapse-a2a/references/*.md
读取以下文件以了解当前的代码实现和文档内容：
  1. 代码实现：
    synapse/
    目录下的关键文件
    • synapse/tools/a2a.py
      - CLI工具实现代码
    • synapse/a2a_client.py
      - A2A客户端
    • synapse/cli.py
      - 主CLI入口文件
    • synapse/commands/*.py
      - 命令实现文件
  2. 文档：
    • README.md
      - 主文档
    • guides/usage.md
      - 使用指南
    • guides/settings.md
      - 设置文档
  3. 当前技能内容：
    • plugins/synapse-a2a/skills/synapse-a2a/SKILL.md
    • plugins/synapse-a2a/skills/synapse-a2a/references/*.md

Step 2: Identify Gaps

步骤2：识别差异

Compare and identify:
  • New CLI options/parameters not documented in skills
  • Changed command syntax or behavior
  • New features mentioned in README but missing from skills
  • Deprecated or removed features still in skills
  • Endpoint path inconsistencies
对比并找出以下不一致之处：
  • 新的CLI选项/参数未在技能文档中记录
  • 命令语法或行为已变更
  • README中提及的新功能未在技能文档中体现
  • 已弃用或移除的功能仍存在于技能文档中
  • 端点路径不一致

Step 3: Update Skills

步骤3：更新技能内容

Update skill files to match current state:
synapse-a2a/SKILL.md:
  • Quick Reference table
  • Command examples
  • Feature descriptions
synapse-a2a/references/commands.md:
  • Full CLI command documentation
  • All options and parameters
  • Example usage
synapse-a2a/references/api.md:
  • Endpoint paths
  • Request/response formats
  • Extension endpoints
更新技能文件以匹配当前状态：
synapse-a2a/SKILL.md：
  • 快速参考表格
  • 命令示例
  • 功能描述
synapse-a2a/references/commands.md：
  • 完整的CLI命令文档
  • 所有选项和参数
  • 使用示例
synapse-a2a/references/api.md：
  • 端点路径
  • 请求/响应格式
  • 扩展端点

Step 4: Verify Consistency

步骤4：验证一致性

Ensure consistency across:
  • Endpoint paths match between README and skills
  • Command syntax is identical
  • Option names and defaults match implementation
  • Examples use correct syntax
确保以下内容保持一致：
  • README与技能文档中的端点路径匹配
  • 命令语法完全相同
  • 选项名称和默认值与代码实现一致
  • 示例使用正确的语法

Key Areas to Check

重点检查区域

Command Options

命令选项

bash
undefined
bash
undefined

Check synapse/tools/a2a.py for current options

Check synapse/tools/a2a.py for current options

synapse send <target> <message> [options]

Key options to verify:
- `--from` / `-f`: Sender identification
- `--priority` / `-p`: Priority levels (1-5)
- `--response` / `--no-response`: Roundtrip control
- `--reply-to`: Reply to specific task
synapse send <target> <message> [options]

需要验证的关键选项：
- `--from` / `-f`：发送方标识
- `--priority` / `-p`：优先级等级（1-5）
- `--response` / `--no-response`：往返控制
- `--reply-to`：回复特定任务

API Endpoints

API端点

/.well-known/agent.json    # Agent Card
/tasks/send                # Standard A2A
/tasks/send-priority       # Synapse extension
/tasks/{id}                # Task status
/status                    # Agent status
/.well-known/agent.json    # Agent Card
/tasks/send                # Standard A2A
/tasks/send-priority       # Synapse extension
/tasks/{id}                # Task status
/status                    # Agent status

Settings Commands

设置命令

bash
synapse init               # Initialize .synapse/
synapse config             # Interactive TUI
synapse config show        # View settings
synapse reset              # Reset to defaults
bash
synapse init               # Initialize .synapse/
synapse config             # Interactive TUI
synapse config show        # View settings
synapse reset              # Reset to defaults

Output

输出结果

After synchronization, report:
  1. Files that were updated
  2. Specific changes made
  3. Any manual review needed
同步完成后，将生成以下报告：
  1. 已更新的文件列表
  2. 具体变更内容
  3. 需要人工检查的事项

Notes

注意事项

  • Preserve skill file structure (YAML frontmatter + markdown)
  • Keep descriptions concise and actionable
  • Use imperative form for instructions
  • Avoid duplicating content between SKILL.md and references/
  • 保留技能文件的结构（YAML前置元数据 + Markdown内容）
  • 描述需简洁且具有可操作性
  • 说明性内容使用祈使句
  • 避免在SKILL.md和references/目录下的文档中重复内容